Class: AWSCDK::MediaTailor::CfnPlaybackConfigurationProps

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

Overview

Properties for defining a CfnPlaybackConfiguration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ad_decision_server_url:, name:, video_content_source_url:, ad_conditioning_configuration: nil, ad_decision_server_configuration: nil, avail_suppression: nil, bumper: nil, cdn_configuration: nil, configuration_aliases: nil, dash_configuration: nil, function_mapping: nil, hls_configuration: nil, insertion_mode: nil, live_pre_roll_configuration: nil, log_configuration: nil, manifest_processing_rules: nil, personalization_threshold_seconds: nil, slate_ad_url: nil, tags: nil, transcode_profile_name: nil) ⇒ CfnPlaybackConfigurationProps

Returns a new instance of CfnPlaybackConfigurationProps.

Parameters:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 29

def initialize(ad_decision_server_url:, name:, video_content_source_url:, ad_conditioning_configuration: nil, ad_decision_server_configuration: nil, avail_suppression: nil, bumper: nil, cdn_configuration: nil, configuration_aliases: nil, dash_configuration: nil, function_mapping: nil, hls_configuration: nil, insertion_mode: nil, live_pre_roll_configuration: nil, log_configuration: nil, manifest_processing_rules: nil, personalization_threshold_seconds: nil, slate_ad_url: nil, tags: nil, transcode_profile_name: nil)
  @ad_decision_server_url = ad_decision_server_url
  Jsii::Type.check_type(@ad_decision_server_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "adDecisionServerUrl")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @video_content_source_url = video_content_source_url
  Jsii::Type.check_type(@video_content_source_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "videoContentSourceUrl")
  @ad_conditioning_configuration = ad_conditioning_configuration.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::AdConditioningConfigurationProperty.new(**ad_conditioning_configuration.transform_keys(&:to_sym)) : ad_conditioning_configuration
  Jsii::Type.check_type(@ad_conditioning_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uQWRDb25kaXRpb25pbmdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "adConditioningConfiguration") unless @ad_conditioning_configuration.nil?
  @ad_decision_server_configuration = ad_decision_server_configuration.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::AdDecisionServerConfigurationProperty.new(**ad_decision_server_configuration.transform_keys(&:to_sym)) : ad_decision_server_configuration
  Jsii::Type.check_type(@ad_decision_server_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uQWREZWNpc2lvblNlcnZlckNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "adDecisionServerConfiguration") unless @ad_decision_server_configuration.nil?
  @avail_suppression = avail_suppression.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::AvailSuppressionProperty.new(**avail_suppression.transform_keys(&:to_sym)) : avail_suppression
  Jsii::Type.check_type(@avail_suppression, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uQXZhaWxTdXBwcmVzc2lvblByb3BlcnR5In1dfX0=")), "availSuppression") unless @avail_suppression.nil?
  @bumper = bumper.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::BumperProperty.new(**bumper.transform_keys(&:to_sym)) : bumper
  Jsii::Type.check_type(@bumper, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uQnVtcGVyUHJvcGVydHkifV19fQ==")), "bumper") unless @bumper.nil?
  @cdn_configuration = cdn_configuration.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::CdnConfigurationProperty.new(**cdn_configuration.transform_keys(&:to_sym)) : cdn_configuration
  Jsii::Type.check_type(@cdn_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uQ2RuQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "cdnConfiguration") unless @cdn_configuration.nil?
  @configuration_aliases = configuration_aliases
  Jsii::Type.check_type(@configuration_aliases, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siY29sbGVjdGlvbiI6eyJlbGVtZW50dHlwZSI6eyJwcmltaXRpdmUiOiJhbnkifSwia2luZCI6Im1hcCJ9fSx7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn1dfX0=")), "configurationAliases") unless @configuration_aliases.nil?
  @dash_configuration = dash_configuration.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::DashConfigurationProperty.new(**dash_configuration.transform_keys(&:to_sym)) : dash_configuration
  Jsii::Type.check_type(@dash_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uRGFzaENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "dashConfiguration") unless @dash_configuration.nil?
  @function_mapping = function_mapping
  Jsii::Type.check_type(@function_mapping, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "functionMapping") unless @function_mapping.nil?
  @hls_configuration = hls_configuration.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::HlsConfigurationProperty.new(**hls_configuration.transform_keys(&:to_sym)) : hls_configuration
  Jsii::Type.check_type(@hls_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uSGxzQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "hlsConfiguration") unless @hls_configuration.nil?
  @insertion_mode = insertion_mode
  Jsii::Type.check_type(@insertion_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "insertionMode") unless @insertion_mode.nil?
  @live_pre_roll_configuration = live_pre_roll_configuration.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::LivePreRollConfigurationProperty.new(**live_pre_roll_configuration.transform_keys(&:to_sym)) : live_pre_roll_configuration
  Jsii::Type.check_type(@live_pre_roll_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uTGl2ZVByZVJvbGxDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "livePreRollConfiguration") unless @live_pre_roll_configuration.nil?
  @log_configuration = log_configuration.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::LogConfigurationProperty.new(**log_configuration.transform_keys(&:to_sym)) : log_configuration
  Jsii::Type.check_type(@log_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uTG9nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "logConfiguration") unless @log_configuration.nil?
  @manifest_processing_rules = manifest_processing_rules.is_a?(Hash) ? ::AWSCDK::MediaTailor::CfnPlaybackConfiguration::ManifestProcessingRulesProperty.new(**manifest_processing_rules.transform_keys(&:to_sym)) : manifest_processing_rules
  Jsii::Type.check_type(@manifest_processing_rules, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXRhaWxvci5DZm5QbGF5YmFja0NvbmZpZ3VyYXRpb24uTWFuaWZlc3RQcm9jZXNzaW5nUnVsZXNQcm9wZXJ0eSJ9XX19")), "manifestProcessingRules") unless @manifest_processing_rules.nil?
  @personalization_threshold_seconds = personalization_threshold_seconds
  Jsii::Type.check_type(@personalization_threshold_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "personalizationThresholdSeconds") unless @personalization_threshold_seconds.nil?
  @slate_ad_url = slate_ad_url
  Jsii::Type.check_type(@slate_ad_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "slateAdUrl") unless @slate_ad_url.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @transcode_profile_name = transcode_profile_name
  Jsii::Type.check_type(@transcode_profile_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transcodeProfileName") unless @transcode_profile_name.nil?
end

Instance Attribute Details

#ad_conditioning_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.

Returns:

See Also:



95
96
97
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 95

def ad_conditioning_configuration
  @ad_conditioning_configuration
end

#ad_decision_server_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration for the request to the specified Ad Decision Server URL.

Returns:

See Also:



100
101
102
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 100

def ad_decision_server_configuration
  @ad_decision_server_configuration
end

#ad_decision_server_url ⇒ String (readonly)

The URL for the ad decision server (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)

See Also:



78
79
80
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 78

def ad_decision_server_url
  @ad_decision_server_url
end

#avail_suppression ⇒ AWSCDK::IResolvable, ... (readonly)

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

For more information about ad suppression, see Ad Suppression .

Returns:

See Also:



107
108
109
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 107

def avail_suppression
  @avail_suppression
end

#bumper ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration for bumpers.

Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers .

Returns:

See Also:



114
115
116
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 114

def bumper
  @bumper
end

#cdn_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

Returns:

See Also:



119
120
121
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 119

def cdn_configuration
  @cdn_configuration
end

#configuration_aliases ⇒ Hash{String => Object}, ... (readonly)

The player parameters and aliases used as dynamic variables during session initialization.

For more information, see Domain Variables .

Returns:

See Also:



126
127
128
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 126

def configuration_aliases
  @configuration_aliases
end

#dash_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration for a DASH source.

Returns:

See Also:



131
132
133
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 131

def dash_configuration
  @dash_configuration
end

#function_mapping ⇒ AWSCDK::IResolvable, ... (readonly)

A map of event names to function identifiers for custom processing during session lifecycle events.

Returns:

See Also:



136
137
138
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 136

def function_mapping
  @function_mapping
end

#hls_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration for HLS content.

Returns:

See Also:



141
142
143
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 141

def hls_configuration
  @hls_configuration
end

#insertion_mode ⇒ String? (readonly)

The setting that controls whether players can use stitched or guided ad insertion.

The default, STITCHED_ONLY , forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.

Returns:

  • (String, nil)

See Also:



148
149
150
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 148

def insertion_mode
  @insertion_mode
end

#live_pre_roll_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration for pre-roll ad insertion.

Returns:

See Also:



153
154
155
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 153

def live_pre_roll_configuration
  @live_pre_roll_configuration
end

#log_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

Returns:

See Also:



158
159
160
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 158

def log_configuration
  @log_configuration
end

#manifest_processing_rules ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration for manifest processing rules.

Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Returns:

See Also:



165
166
167
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 165

def manifest_processing_rules
  @manifest_processing_rules
end

#name ⇒ String (readonly)

The identifier for the playback configuration.

Returns:

  • (String)

See Also:



83
84
85
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 83

def name
  @name
end

#personalization_threshold_seconds ⇒ Numeric? (readonly)

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.

If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor .

Returns:

  • (Numeric, nil)

See Also:



172
173
174
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 172

def personalization_threshold_seconds
  @personalization_threshold_seconds
end

#slate_ad_url ⇒ String? (readonly)

The URL for a video asset to transcode and use to fill in time that's not used by ads.

AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

Returns:

  • (String, nil)

See Also:



179
180
181
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 179

def slate_ad_url
  @slate_ad_url
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags to assign to the playback configuration.

Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .

Returns:

See Also:



186
187
188
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 186

def tags
  @tags
end

#transcode_profile_name ⇒ String? (readonly)

The name that is used to associate this playback configuration with a custom transcode profile.

This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

Returns:

  • (String, nil)

See Also:



193
194
195
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 193

def transcode_profile_name
  @transcode_profile_name
end

#video_content_source_url ⇒ String (readonly)

The URL prefix for the parent manifest for the stream, minus the asset ID.

The maximum length is 512 characters.

Returns:

  • (String)

See Also:



90
91
92
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 90

def video_content_source_url
  @video_content_source_url
end

Class Method Details

.jsii_properties ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 195

def self.jsii_properties
  {
    :ad_decision_server_url => "adDecisionServerUrl",
    :name => "name",
    :video_content_source_url => "videoContentSourceUrl",
    :ad_conditioning_configuration => "adConditioningConfiguration",
    :ad_decision_server_configuration => "adDecisionServerConfiguration",
    :avail_suppression => "availSuppression",
    :bumper => "bumper",
    :cdn_configuration => "cdnConfiguration",
    :configuration_aliases => "configurationAliases",
    :dash_configuration => "dashConfiguration",
    :function_mapping => "functionMapping",
    :hls_configuration => "hlsConfiguration",
    :insertion_mode => "insertionMode",
    :live_pre_roll_configuration => "livePreRollConfiguration",
    :log_configuration => "logConfiguration",
    :manifest_processing_rules => "manifestProcessingRules",
    :personalization_threshold_seconds => "personalizationThresholdSeconds",
    :slate_ad_url => "slateAdUrl",
    :tags => "tags",
    :transcode_profile_name => "transcodeProfileName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'media_tailor/cfn_playback_configuration_props.rb', line 220

def to_jsii
  result = {}
  result.merge!({
    "adDecisionServerUrl" => @ad_decision_server_url,
    "name" => @name,
    "videoContentSourceUrl" => @video_content_source_url,
    "adConditioningConfiguration" => @ad_conditioning_configuration,
    "adDecisionServerConfiguration" => @ad_decision_server_configuration,
    "availSuppression" => @avail_suppression,
    "bumper" => @bumper,
    "cdnConfiguration" => @cdn_configuration,
    "configurationAliases" => @configuration_aliases,
    "dashConfiguration" => @dash_configuration,
    "functionMapping" => @function_mapping,
    "hlsConfiguration" => @hls_configuration,
    "insertionMode" => @insertion_mode,
    "livePreRollConfiguration" => @live_pre_roll_configuration,
    "logConfiguration" => @log_configuration,
    "manifestProcessingRules" => @manifest_processing_rules,
    "personalizationThresholdSeconds" => @personalization_threshold_seconds,
    "slateAdUrl" => @slate_ad_url,
    "tags" => @tags,
    "transcodeProfileName" => @transcode_profile_name,
  })
  result.compact
end