@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:40.954Z") @Stability(value=Stable) public class CfnPlaybackConfiguration extends CfnResource implements IInspectable
Adds a new playback configuration to AWS Elemental MediaTailor.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.mediatailor.*;
Object configurationAliases;
CfnPlaybackConfiguration cfnPlaybackConfiguration = CfnPlaybackConfiguration.Builder.create(this, "MyCfnPlaybackConfiguration")
.adDecisionServerUrl("adDecisionServerUrl")
.name("name")
.videoContentSourceUrl("videoContentSourceUrl")
// the properties below are optional
.availSuppression(AvailSuppressionProperty.builder()
.mode("mode")
.value("value")
.build())
.bumper(BumperProperty.builder()
.endUrl("endUrl")
.startUrl("startUrl")
.build())
.cdnConfiguration(CdnConfigurationProperty.builder()
.adSegmentUrlPrefix("adSegmentUrlPrefix")
.contentSegmentUrlPrefix("contentSegmentUrlPrefix")
.build())
.configurationAliases(Map.of(
"configurationAliasesKey", configurationAliases))
.dashConfiguration(DashConfigurationProperty.builder()
.manifestEndpointPrefix("manifestEndpointPrefix")
.mpdLocation("mpdLocation")
.originManifestType("originManifestType")
.build())
.livePreRollConfiguration(LivePreRollConfigurationProperty.builder()
.adDecisionServerUrl("adDecisionServerUrl")
.maxDurationSeconds(123)
.build())
.manifestProcessingRules(ManifestProcessingRulesProperty.builder()
.adMarkerPassthrough(AdMarkerPassthroughProperty.builder()
.enabled(false)
.build())
.build())
.personalizationThresholdSeconds(123)
.slateAdUrl("slateAdUrl")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.transcodeProfileName("transcodeProfileName")
.build();
| Modifier and Type | Class and Description |
|---|---|
static interface |
CfnPlaybackConfiguration.AdMarkerPassthroughProperty
For HLS, when set to `true` , MediaTailor passes through `EXT-X-CUE-IN` , `EXT-X-CUE-OUT` , and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest.
|
static interface |
CfnPlaybackConfiguration.AvailSuppressionProperty
The configuration for avail suppression, also known as ad suppression.
|
static class |
CfnPlaybackConfiguration.Builder
A fluent builder for
CfnPlaybackConfiguration. |
static interface |
CfnPlaybackConfiguration.BumperProperty
The configuration for bumpers.
|
static interface |
CfnPlaybackConfiguration.CdnConfigurationProperty
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
|
static interface |
CfnPlaybackConfiguration.DashConfigurationProperty
The configuration for DASH content.
|
static interface |
CfnPlaybackConfiguration.HlsConfigurationProperty
The configuration for HLS content.
|
static interface |
CfnPlaybackConfiguration.LivePreRollConfigurationProperty
The configuration for pre-roll ad insertion.
|
static interface |
CfnPlaybackConfiguration.ManifestProcessingRulesProperty
The configuration for manifest processing rules.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnPlaybackConfiguration(software.constructs.Construct scope,
String id,
CfnPlaybackConfigurationProps props)
Create a new `AWS::MediaTailor::PlaybackConfiguration`.
|
protected |
CfnPlaybackConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnPlaybackConfiguration(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
String |
getAdDecisionServerUrl()
The URL for the ad decision server (ADS).
|
String |
getAttrDashConfigurationManifestEndpointPrefix() |
String |
getAttrHlsConfigurationManifestEndpointPrefix() |
String |
getAttrPlaybackConfigurationArn() |
String |
getAttrPlaybackEndpointPrefix() |
String |
getAttrSessionInitializationEndpointPrefix() |
Object |
getAvailSuppression()
The configuration for avail suppression, also known as ad suppression.
|
Object |
getBumper()
The configuration for bumpers.
|
Object |
getCdnConfiguration()
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getConfigurationAliases()
The player parameters and aliases used as dynamic variables during session initialization.
|
Object |
getDashConfiguration()
The configuration for DASH content.
|
Object |
getLivePreRollConfiguration()
The configuration for pre-roll ad insertion.
|
Object |
getManifestProcessingRules()
The configuration for manifest processing rules.
|
String |
getName()
The identifier for the playback configuration.
|
Number |
getPersonalizationThresholdSeconds()
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
|
String |
getSlateAdUrl()
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
|
TagManager |
getTags()
The tags to assign to the playback configuration.
|
String |
getTranscodeProfileName()
The name that is used to associate this playback configuration with a custom transcode profile.
|
String |
getVideoContentSourceUrl()
The URL prefix for the parent manifest for the stream, minus the asset ID.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAdDecisionServerUrl(String value)
The URL for the ad decision server (ADS).
|
void |
setAvailSuppression(CfnPlaybackConfiguration.AvailSuppressionProperty value)
The configuration for avail suppression, also known as ad suppression.
|
void |
setAvailSuppression(IResolvable value)
The configuration for avail suppression, also known as ad suppression.
|
void |
setBumper(CfnPlaybackConfiguration.BumperProperty value)
The configuration for bumpers.
|
void |
setBumper(IResolvable value)
The configuration for bumpers.
|
void |
setCdnConfiguration(CfnPlaybackConfiguration.CdnConfigurationProperty value)
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
|
void |
setCdnConfiguration(IResolvable value)
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
|
void |
setConfigurationAliases(IResolvable value)
The player parameters and aliases used as dynamic variables during session initialization.
|
void |
setConfigurationAliases(Map<String,Object> value)
The player parameters and aliases used as dynamic variables during session initialization.
|
void |
setDashConfiguration(CfnPlaybackConfiguration.DashConfigurationProperty value)
The configuration for DASH content.
|
void |
setDashConfiguration(IResolvable value)
The configuration for DASH content.
|
void |
setLivePreRollConfiguration(CfnPlaybackConfiguration.LivePreRollConfigurationProperty value)
The configuration for pre-roll ad insertion.
|
void |
setLivePreRollConfiguration(IResolvable value)
The configuration for pre-roll ad insertion.
|
void |
setManifestProcessingRules(CfnPlaybackConfiguration.ManifestProcessingRulesProperty value)
The configuration for manifest processing rules.
|
void |
setManifestProcessingRules(IResolvable value)
The configuration for manifest processing rules.
|
void |
setName(String value)
The identifier for the playback configuration.
|
void |
setPersonalizationThresholdSeconds(Number value)
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
|
void |
setSlateAdUrl(String value)
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
|
void |
setTranscodeProfileName(String value)
The name that is used to associate this playback configuration with a custom transcode profile.
|
void |
setVideoContentSourceUrl(String value)
The URL prefix for the parent manifest for the stream, minus the asset ID.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnPlaybackConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnPlaybackConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnPlaybackConfiguration(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnPlaybackConfigurationProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrDashConfigurationManifestEndpointPrefix()
@Stability(value=Stable) @NotNull public String getAttrHlsConfigurationManifestEndpointPrefix()
@Stability(value=Stable) @NotNull public String getAttrPlaybackConfigurationArn()
@Stability(value=Stable) @NotNull public String getAttrPlaybackEndpointPrefix()
@Stability(value=Stable) @NotNull public String getAttrSessionInitializationEndpointPrefix()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
@Stability(value=Stable) @NotNull public String getAdDecisionServerUrl()
This includes the specification of static parameters and placeholders for dynamic parameters. 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.
@Stability(value=Stable)
public void setAdDecisionServerUrl(@NotNull
String value)
This includes the specification of static parameters and placeholders for dynamic parameters. 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.
@Stability(value=Stable) @NotNull public String getName()
@Stability(value=Stable)
public void setName(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getVideoContentSourceUrl()
The maximum length is 512 characters.
@Stability(value=Stable)
public void setVideoContentSourceUrl(@NotNull
String value)
The maximum length is 512 characters.
@Stability(value=Stable) @Nullable public Object getAvailSuppression()
For more information about ad suppression, see Ad Suppression .
@Stability(value=Stable)
public void setAvailSuppression(@Nullable
CfnPlaybackConfiguration.AvailSuppressionProperty value)
For more information about ad suppression, see Ad Suppression .
@Stability(value=Stable)
public void setAvailSuppression(@Nullable
IResolvable value)
For more information about ad suppression, see Ad Suppression .
@Stability(value=Stable) @Nullable public Object getBumper()
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 .
@Stability(value=Stable)
public void setBumper(@Nullable
CfnPlaybackConfiguration.BumperProperty value)
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 .
@Stability(value=Stable)
public void setBumper(@Nullable
IResolvable value)
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 .
@Stability(value=Stable) @Nullable public Object getCdnConfiguration()
@Stability(value=Stable)
public void setCdnConfiguration(@Nullable
CfnPlaybackConfiguration.CdnConfigurationProperty value)
@Stability(value=Stable)
public void setCdnConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getConfigurationAliases()
For more information, see Domain Variables .
@Stability(value=Stable)
public void setConfigurationAliases(@Nullable
IResolvable value)
For more information, see Domain Variables .
@Stability(value=Stable)
public void setConfigurationAliases(@Nullable
Map<String,Object> value)
For more information, see Domain Variables .
@Stability(value=Stable) @Nullable public Object getDashConfiguration()
@Stability(value=Stable)
public void setDashConfiguration(@Nullable
CfnPlaybackConfiguration.DashConfigurationProperty value)
@Stability(value=Stable)
public void setDashConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getLivePreRollConfiguration()
@Stability(value=Stable)
public void setLivePreRollConfiguration(@Nullable
CfnPlaybackConfiguration.LivePreRollConfigurationProperty value)
@Stability(value=Stable)
public void setLivePreRollConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getManifestProcessingRules()
Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
@Stability(value=Stable)
public void setManifestProcessingRules(@Nullable
CfnPlaybackConfiguration.ManifestProcessingRulesProperty value)
Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
@Stability(value=Stable)
public void setManifestProcessingRules(@Nullable
IResolvable value)
Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
@Stability(value=Stable) @Nullable public Number getPersonalizationThresholdSeconds()
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 MediaTailor .
@Stability(value=Stable)
public void setPersonalizationThresholdSeconds(@Nullable
Number value)
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 MediaTailor .
@Stability(value=Stable) @Nullable public String getSlateAdUrl()
MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
@Stability(value=Stable)
public void setSlateAdUrl(@Nullable
String value)
MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
@Stability(value=Stable) @Nullable public String getTranscodeProfileName()
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.
@Stability(value=Stable)
public void setTranscodeProfileName(@Nullable
String value)
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.
Copyright © 2022. All rights reserved.