Class: AWSCDK::MediaTailor::CfnPlaybackConfiguration::LivePreRollConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::MediaTailor::CfnPlaybackConfiguration::LivePreRollConfigurationProperty

Defined in:

media_tailor/cfn_playback_configuration.rb

Overview

The configuration for pre-roll ad insertion.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html

Instance Attribute Summary

• #ad_decision_server_url ⇒ String^? readonly

  The URL for the ad decision server (ADS) for pre-roll ads.

• #max_duration_seconds ⇒ Numeric^? readonly

  The maximum allowed duration for the pre-roll ad avail.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(ad_decision_server_url: nil, max_duration_seconds: nil) ⇒ LivePreRollConfigurationProperty constructor

  A new instance of LivePreRollConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(ad_decision_server_url: nil, max_duration_seconds: nil) ⇒ LivePreRollConfigurationProperty

Returns a new instance of LivePreRollConfigurationProperty.

Parameters:

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

  The URL for the ad decision server (ADS) for pre-roll ads.

• max_duration_seconds (Numeric, nil) (defaults to: nil) —

  The maximum allowed duration for the pre-roll ad avail.

# File 'media_tailor/cfn_playback_configuration.rb', line 1277

def initialize(ad_decision_server_url: nil, max_duration_seconds: nil)
  @ad_decision_server_url = ad_decision_server_url
  Jsii::Type.check_type(@ad_decision_server_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "adDecisionServerUrl") unless @ad_decision_server_url.nil?
  @max_duration_seconds = max_duration_seconds
  Jsii::Type.check_type(@max_duration_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxDurationSeconds") unless @max_duration_seconds.nil?
end

Instance Attribute Details

#ad_decision_server_url ⇒ String^? (readonly)

The URL for the ad decision server (ADS) for pre-roll ads.

This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration-addecisionserverurl

# File 'media_tailor/cfn_playback_configuration.rb', line 1290

def ad_decision_server_url
  @ad_decision_server_url
end

#max_duration_seconds ⇒ Numeric^? (readonly)

The maximum allowed duration for the pre-roll ad avail.

AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration-maxdurationseconds

# File 'media_tailor/cfn_playback_configuration.rb', line 1297

def max_duration_seconds
  @max_duration_seconds
end

Class Method Details

.jsii_properties ⇒ Object

# File 'media_tailor/cfn_playback_configuration.rb', line 1299

def self.jsii_properties
  {
    :ad_decision_server_url => "adDecisionServerUrl",
    :max_duration_seconds => "maxDurationSeconds",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'media_tailor/cfn_playback_configuration.rb', line 1306

def to_jsii
  result = {}
  result.merge!({
    "adDecisionServerUrl" => @ad_decision_server_url,
    "maxDurationSeconds" => @max_duration_seconds,
  })
  result.compact
end