Class: AWSCDK::MediaTailor::CfnPlaybackConfiguration::AvailSuppressionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_tailor/cfn_playback_configuration.rb

Overview

The configuration for avail suppression, also known as ad suppression.

For more information about ad suppression, see Ad Suppression .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fill_policy: nil, mode: nil, value: nil) ⇒ AvailSuppressionProperty

Returns a new instance of AvailSuppressionProperty.

Parameters:

  • fill_policy (String, nil) (defaults to: nil) —

    Defines the policy to apply to the avail suppression mode.

  • mode (String, nil) (defaults to: nil) —

    Sets the ad suppression mode.

  • value (String, nil) (defaults to: nil) —

    A live edge offset time in HH:MM:SS.



964
965
966
967
968
969
970
971
 
# File 'media_tailor/cfn_playback_configuration.rb', line 964

def initialize(fill_policy: nil, mode: nil, value: nil)
  @fill_policy = fill_policy
  Jsii::Type.check_type(@fill_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fillPolicy") unless @fill_policy.nil?
  @mode = mode
  Jsii::Type.check_type(@mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mode") unless @mode.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

#fill_policy ⇒ String? (readonly)

Defines the policy to apply to the avail suppression mode.

BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.

Returns:

  • (String, nil)

See Also:



979
980
981
 
# File 'media_tailor/cfn_playback_configuration.rb', line 979

def fill_policy
  @fill_policy
end

#mode ⇒ String? (readonly)

Sets the ad suppression mode.

By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE , ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE , ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.

Returns:

  • (String, nil)

See Also:



986
987
988
 
# File 'media_tailor/cfn_playback_configuration.rb', line 986

def mode
  @mode
end

#value ⇒ String? (readonly)

A live edge offset time in HH:MM:SS.

MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

Returns:

  • (String, nil)

See Also:



993
994
995
 
# File 'media_tailor/cfn_playback_configuration.rb', line 993

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



995
996
997
998
999
1000
1001
 
# File 'media_tailor/cfn_playback_configuration.rb', line 995

def self.jsii_properties
  {
    :fill_policy => "fillPolicy",
    :mode => "mode",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'media_tailor/cfn_playback_configuration.rb', line 1003

def to_jsii
  result = {}
  result.merge!({
    "fillPolicy" => @fill_policy,
    "mode" => @mode,
    "value" => @value,
  })
  result.compact
end