Class CfnPlaybackConfiguration
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.mediatailor.CfnPlaybackConfiguration
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:12.956Z")
@Stability(Stable)
public class CfnPlaybackConfiguration
extends CfnResource
implements IInspectable, ITaggable
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() .fillPolicy("fillPolicy") .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()) .hlsConfiguration(HlsConfigurationProperty.builder() .manifestEndpointPrefix("manifestEndpointPrefix") .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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
For HLS, when set totrue
, MediaTailor passes throughEXT-X-CUE-IN
,EXT-X-CUE-OUT
, andEXT-X-SPLICEPOINT-SCTE35
ad markers from the origin manifest to the MediaTailor personalized manifest.static interface
The configuration for avail suppression, also known as ad suppression.static final class
A fluent builder forCfnPlaybackConfiguration
.static interface
The configuration for bumpers.static interface
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.static interface
The configuration for DASH content.static interface
The configuration for HLS content.static interface
The configuration for pre-roll ad insertion.static interface
The configuration for manifest processing rules.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnPlaybackConfiguration
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnPlaybackConfiguration
(software.amazon.jsii.JsiiObjectRef objRef) CfnPlaybackConfiguration
(software.constructs.Construct scope, String id, CfnPlaybackConfigurationProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe URL for the ad decision server (ADS).The URL generated by MediaTailor to initiate a playback session.The URL that is used to initiate a playback session for devices that support Apple HLS.The Amazon Resource Name (ARN) for the playback configuration.The URL that the player accesses to get a manifest from MediaTailor .The URL that the player uses to initialize a session that uses client-side reporting.The configuration for avail suppression, also known as ad suppression.The configuration for bumpers.The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.The player parameters and aliases used as dynamic variables during session initialization.The configuration for a DASH source.The configuration for HLS content.The configuration for pre-roll ad insertion.The configuration for manifest processing rules.getName()
The identifier for the playback configuration.Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.The URL for a video asset to transcode and use to fill in time that's not used by ads.getTags()
Tag Manager which manages the tags for this resource.The tags to assign to the playback configuration.The name that is used to associate this playback configuration with a custom transcode profile.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.renderProperties
(Map<String, Object> props) void
setAdDecisionServerUrl
(String value) The URL for the ad decision server (ADS).void
setAvailSuppression
(IResolvable value) The configuration for avail suppression, also known as ad suppression.void
The configuration for avail suppression, also known as ad suppression.void
setBumper
(IResolvable value) The configuration for bumpers.void
The configuration for bumpers.void
setCdnConfiguration
(IResolvable value) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.void
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.void
setConfigurationAliases
(Map<String, Object> value) The player parameters and aliases used as dynamic variables during session initialization.void
The player parameters and aliases used as dynamic variables during session initialization.void
setDashConfiguration
(IResolvable value) The configuration for a DASH source.void
The configuration for a DASH source.void
setHlsConfiguration
(IResolvable value) The configuration for HLS content.void
The configuration for HLS content.void
The configuration for pre-roll ad insertion.void
The configuration for pre-roll ad insertion.void
The configuration for manifest processing rules.void
The configuration for manifest processing rules.void
The identifier for the playback configuration.void
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.void
setSlateAdUrl
(String value) The URL for a video asset to transcode and use to fill in time that's not used by ads.void
setTagsRaw
(List<CfnTag> value) The tags to assign to the playback configuration.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.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnPlaybackConfiguration
protected CfnPlaybackConfiguration(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPlaybackConfiguration
protected CfnPlaybackConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPlaybackConfiguration
@Stability(Stable) public CfnPlaybackConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPlaybackConfigurationProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrDashConfigurationManifestEndpointPrefix
The URL generated by MediaTailor to initiate a playback session.The session uses server-side reporting. This setting is ignored in PUT operations.
-
getAttrHlsConfigurationManifestEndpointPrefix
The URL that is used to initiate a playback session for devices that support Apple HLS.The session uses server-side reporting.
-
getAttrPlaybackConfigurationArn
The Amazon Resource Name (ARN) for the playback configuration. -
getAttrPlaybackEndpointPrefix
The URL that the player accesses to get a manifest from MediaTailor .This session will use server-side reporting.
-
getAttrSessionInitializationEndpointPrefix
The URL that the player uses to initialize a session that uses client-side reporting. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAdDecisionServerUrl
The URL for the ad decision server (ADS). -
setAdDecisionServerUrl
The URL for the ad decision server (ADS). -
getName
The identifier for the playback configuration. -
setName
The identifier for the playback configuration. -
getVideoContentSourceUrl
The URL prefix for the parent manifest for the stream, minus the asset ID. -
setVideoContentSourceUrl
The URL prefix for the parent manifest for the stream, minus the asset ID. -
getAvailSuppression
The configuration for avail suppression, also known as ad suppression. -
setAvailSuppression
The configuration for avail suppression, also known as ad suppression. -
setAvailSuppression
@Stability(Stable) public void setAvailSuppression(@Nullable CfnPlaybackConfiguration.AvailSuppressionProperty value) The configuration for avail suppression, also known as ad suppression. -
getBumper
The configuration for bumpers. -
setBumper
The configuration for bumpers. -
setBumper
The configuration for bumpers. -
getCdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. -
setCdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. -
setCdnConfiguration
@Stability(Stable) public void setCdnConfiguration(@Nullable CfnPlaybackConfiguration.CdnConfigurationProperty value) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. -
getConfigurationAliases
The player parameters and aliases used as dynamic variables during session initialization. -
setConfigurationAliases
The player parameters and aliases used as dynamic variables during session initialization. -
setConfigurationAliases
The player parameters and aliases used as dynamic variables during session initialization. -
getDashConfiguration
The configuration for a DASH source. -
setDashConfiguration
The configuration for a DASH source. -
setDashConfiguration
@Stability(Stable) public void setDashConfiguration(@Nullable CfnPlaybackConfiguration.DashConfigurationProperty value) The configuration for a DASH source. -
getHlsConfiguration
The configuration for HLS content. -
setHlsConfiguration
The configuration for HLS content. -
setHlsConfiguration
@Stability(Stable) public void setHlsConfiguration(@Nullable CfnPlaybackConfiguration.HlsConfigurationProperty value) The configuration for HLS content. -
getLivePreRollConfiguration
The configuration for pre-roll ad insertion. -
setLivePreRollConfiguration
The configuration for pre-roll ad insertion. -
setLivePreRollConfiguration
@Stability(Stable) public void setLivePreRollConfiguration(@Nullable CfnPlaybackConfiguration.LivePreRollConfigurationProperty value) The configuration for pre-roll ad insertion. -
getManifestProcessingRules
The configuration for manifest processing rules. -
setManifestProcessingRules
The configuration for manifest processing rules. -
setManifestProcessingRules
@Stability(Stable) public void setManifestProcessingRules(@Nullable CfnPlaybackConfiguration.ManifestProcessingRulesProperty value) The configuration for manifest processing rules. -
getPersonalizationThresholdSeconds
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. -
setPersonalizationThresholdSeconds
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. -
getSlateAdUrl
The URL for a video asset to transcode and use to fill in time that's not used by ads. -
setSlateAdUrl
The URL for a video asset to transcode and use to fill in time that's not used by ads. -
getTagsRaw
The tags to assign to the playback configuration. -
setTagsRaw
The tags to assign to the playback configuration. -
getTranscodeProfileName
The name that is used to associate this playback configuration with a custom transcode profile. -
setTranscodeProfileName
The name that is used to associate this playback configuration with a custom transcode profile.
-