CfnPlaybackConfigurationProps Struct
Properties for defining a CfnPlaybackConfiguration.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediatailor as mediatailor } from 'aws-cdk-lib';
declare const configurationAliases: any;
const cfnPlaybackConfigurationProps: mediatailor.CfnPlaybackConfigurationProps = {
adDecisionServerUrl: 'adDecisionServerUrl',
name: 'name',
videoContentSourceUrl: 'videoContentSourceUrl',
// the properties below are optional
adConditioningConfiguration: {
streamingMediaFileConditioning: 'streamingMediaFileConditioning',
},
adDecisionServerConfiguration: {
httpRequest: {
body: 'body',
compressRequest: 'compressRequest',
headers: {
headersKey: 'headers',
},
httpMethod: 'httpMethod',
},
vastResponse: {
adSequencingMode: 'adSequencingMode',
},
},
adsPersonalizationConcurrency: {
enableVodVastParallelization: false,
maxConcurrentAdsRequests: 123,
},
adsPersonalizationTimeouts: {
adsRequestTimeoutMilliseconds: 123,
liveMaximumAdsPersonalizationTimeMilliseconds: 123,
prefetchAdsRequestTimeoutMilliseconds: 123,
prefetchMaximumAdsPersonalizationTimeMilliseconds: 123,
vodMaximumAdsPersonalizationTimeMilliseconds: 123,
},
availSuppression: {
fillPolicy: 'fillPolicy',
mode: 'mode',
value: 'value',
},
beaconingConfiguration: {
clientSide: {
reportingMode: 'reportingMode',
// the properties below are optional
additionalEventTypes: ['additionalEventTypes'],
},
},
bumper: {
endUrl: 'endUrl',
startUrl: 'startUrl',
},
cdnConfiguration: {
adSegmentUrlPrefix: 'adSegmentUrlPrefix',
contentSegmentUrlPrefix: 'contentSegmentUrlPrefix',
},
configurationAliases: {
configurationAliasesKey: configurationAliases,
},
dashConfiguration: {
manifestEndpointPrefix: 'manifestEndpointPrefix',
mpdLocation: 'mpdLocation',
originManifestType: 'originManifestType',
},
functionMapping: {
functionMappingKey: 'functionMapping',
},
hlsConfiguration: {
manifestEndpointPrefix: 'manifestEndpointPrefix',
},
insertionMode: 'insertionMode',
livePreRollConfiguration: {
adDecisionServerConfiguration: {
vastResponse: {
adSequencingMode: 'adSequencingMode',
},
},
adDecisionServerUrl: 'adDecisionServerUrl',
maxDurationSeconds: 123,
},
logConfiguration: {
percentEnabled: 123,
// the properties below are optional
adsInteractionLog: {
excludeEventTypes: ['excludeEventTypes'],
publishOptInEventTypes: ['publishOptInEventTypes'],
},
enabledLoggingStrategies: ['enabledLoggingStrategies'],
manifestServiceInteractionLog: {
excludeEventTypes: ['excludeEventTypes'],
},
},
manifestProcessingRules: {
adMarkerPassthrough: {
enabled: false,
},
},
personalizationThresholdSeconds: 123,
slateAdUrl: 'slateAdUrl',
tags: [{
key: 'key',
value: 'value',
}],
transcodeProfileName: 'transcodeProfileName',
};
Properties
adConditioningConfigurationoptionalIResolvable | CfnPlaybackConfiguration.AdConditioningConfigurationPropertyad_conditioning_configurationoptionaltyping.Union[IResolvable, AdConditioningConfigurationProperty]adConditioningConfigurationoptionalIResolvableAdConditioningConfigurationoptionalIResolvableAdConditioningConfigurationoptionalinterface{}#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.
adDecisionServerConfigurationoptionalIResolvable | CfnPlaybackConfiguration.AdDecisionServerConfigurationPropertyad_decision_server_configurationoptionaltyping.Union[IResolvable, AdDecisionServerConfigurationProperty]adDecisionServerConfigurationoptionalIResolvableAdDecisionServerConfigurationoptionalIResolvableAdDecisionServerConfigurationoptionalinterface{}#The configuration for the request to the specified Ad Decision Server URL.
adDecisionServerUrlstringad_decision_server_urlstradDecisionServerUrlStringAdDecisionServerUrlstringAdDecisionServerUrl*stringrequired#The URL for the ad decision server (ADS).
notes
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.
adsPersonalizationConcurrencyoptionalIResolvable | CfnPlaybackConfiguration.AdsPersonalizationConcurrencyPropertyads_personalization_concurrencyoptionaltyping.Union[IResolvable, AdsPersonalizationConcurrencyProperty]adsPersonalizationConcurrencyoptionalIResolvableAdsPersonalizationConcurrencyoptionalIResolvableAdsPersonalizationConcurrencyoptionalinterface{}#The settings that control how many concurrent requests MediaTailor makes to the ad decision server (ADS).
adsPersonalizationTimeoutsoptionalIResolvable | CfnPlaybackConfiguration.AdsPersonalizationTimeoutsPropertyads_personalization_timeoutsoptionaltyping.Union[IResolvable, AdsPersonalizationTimeoutsProperty]adsPersonalizationTimeoutsoptionalIResolvableAdsPersonalizationTimeoutsoptionalIResolvableAdsPersonalizationTimeoutsoptionalinterface{}#The ad decision server (ADS) request timeouts and personalization time budgets for live, VOD, and prefetch workflows.
availSuppressionoptionalIResolvable | CfnPlaybackConfiguration.AvailSuppressionPropertyavail_suppressionoptionaltyping.Union[IResolvable, AvailSuppressionProperty]availSuppressionoptionalIResolvableAvailSuppressionoptionalIResolvableAvailSuppressionoptionalinterface{}#The configuration for avail suppression, also known as ad suppression.
For more information about ad suppression, see Ad Suppression .
beaconingConfigurationoptionalIResolvable | CfnPlaybackConfiguration.BeaconingConfigurationPropertybeaconing_configurationoptionaltyping.Union[IResolvable, BeaconingConfigurationProperty]beaconingConfigurationoptionalIResolvableBeaconingConfigurationoptionalIResolvableBeaconingConfigurationoptionalinterface{}#The beaconing configuration for a playback configuration.
Beaconing controls whether AWS Elemental MediaTailor includes its own beacons in the ad tracking response, in addition to the ad server beacons. If you omit this setting, MediaTailor uses INSIGHTS.
bumperoptionalIResolvable | CfnPlaybackConfiguration.BumperPropertybumperoptionaltyping.Union[IResolvable, BumperProperty]bumperoptionalIResolvableBumperoptionalIResolvableBumperoptionalinterface{}#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 .
cdnConfigurationoptionalIResolvable | CfnPlaybackConfiguration.CdnConfigurationPropertycdn_configurationoptionaltyping.Union[IResolvable, CdnConfigurationProperty]cdnConfigurationoptionalIResolvableCdnConfigurationoptionalIResolvableCdnConfigurationoptionalinterface{}#The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
configurationAliasesoptional{ [key: string]: any } | IResolvableconfiguration_aliasesoptionaltyping.Union[typing.Mapping[str, Any], IResolvable]configurationAliasesoptionalMap<String, Object>ConfigurationAliasesoptionalIDictionary<string, object>ConfigurationAliasesoptionalinterface{}#The player parameters and aliases used as dynamic variables during session initialization.
For more information, see Domain Variables .
dashConfigurationoptionalIResolvable | CfnPlaybackConfiguration.DashConfigurationPropertydash_configurationoptionaltyping.Union[IResolvable, DashConfigurationProperty]dashConfigurationoptionalIResolvableDashConfigurationoptionalIResolvableDashConfigurationoptionalinterface{}#The configuration for a DASH source.
functionMappingoptionalIResolvable | { [key: string]: string }function_mappingoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]functionMappingoptionalIResolvableFunctionMappingoptionalIResolvableFunctionMappingoptionalinterface{}#A map of event names to function identifiers for custom processing during session lifecycle events.
hlsConfigurationoptionalIResolvable | CfnPlaybackConfiguration.HlsConfigurationPropertyhls_configurationoptionaltyping.Union[IResolvable, HlsConfigurationProperty]hlsConfigurationoptionalIResolvableHlsConfigurationoptionalIResolvableHlsConfigurationoptionalinterface{}#The configuration for HLS content.
insertionModeoptionalstringinsertion_modeoptionalstrinsertionModeoptionalStringInsertionModeoptionalstringInsertionModeoptional*string#The setting that controls whether players can use stitched or guided ad insertion.
notes
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.
livePreRollConfigurationoptionalIResolvable | CfnPlaybackConfiguration.LivePreRollConfigurationPropertylive_pre_roll_configurationoptionaltyping.Union[IResolvable, LivePreRollConfigurationProperty]livePreRollConfigurationoptionalIResolvableLivePreRollConfigurationoptionalIResolvableLivePreRollConfigurationoptionalinterface{}#The configuration for pre-roll ad insertion.
logConfigurationoptionalIResolvable | CfnPlaybackConfiguration.LogConfigurationPropertylog_configurationoptionaltyping.Union[IResolvable, LogConfigurationProperty]logConfigurationoptionalIResolvableLogConfigurationoptionalIResolvableLogConfigurationoptionalinterface{}#Defines where AWS Elemental MediaTailor sends logs for the playback configuration.
manifestProcessingRulesoptionalIResolvable | CfnPlaybackConfiguration.ManifestProcessingRulesPropertymanifest_processing_rulesoptionaltyping.Union[IResolvable, ManifestProcessingRulesProperty]manifestProcessingRulesoptionalIResolvableManifestProcessingRulesoptionalIResolvableManifestProcessingRulesoptionalinterface{}#The configuration for manifest processing rules.
Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
The identifier for the playback configuration.
personalizationThresholdSecondsoptionalnumberpersonalization_threshold_secondsoptionalint | floatpersonalizationThresholdSecondsoptionalNumberPersonalizationThresholdSecondsoptionaldoublePersonalizationThresholdSecondsoptional*float64#Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
notes
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 .
slateAdUrloptionalstringslate_ad_urloptionalstrslateAdUrloptionalStringSlateAdUrloptionalstringSlateAdUrloptional*string#The URL for a video asset to transcode and use to fill in time that's not used by ads.
notes
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.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#The tags to assign to the playback configuration.
notes
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 .
transcodeProfileNameoptionalstringtranscode_profile_nameoptionalstrtranscodeProfileNameoptionalStringTranscodeProfileNameoptionalstringTranscodeProfileNameoptional*string#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.
videoContentSourceUrlstringvideo_content_source_urlstrvideoContentSourceUrlStringVideoContentSourceUrlstringVideoContentSourceUrl*stringrequired#The URL prefix for the parent manifest for the stream, minus the asset ID.
The maximum length is 512 characters.