Package software.amazon.awscdk.services.mediatailor

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, IEnvironmentAware, IPlaybackConfigurationRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T10:47:24.727Z") @Stability(Stable) public class CfnPlaybackConfiguration extends CfnResource implements IInspectable, IPlaybackConfigurationRef, 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
         .adConditioningConfiguration(AdConditioningConfigurationProperty.builder()
                 .streamingMediaFileConditioning("streamingMediaFileConditioning")
                 .build())
         .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())
         .insertionMode("insertionMode")
         .livePreRollConfiguration(LivePreRollConfigurationProperty.builder()
                 .adDecisionServerUrl("adDecisionServerUrl")
                 .maxDurationSeconds(123)
                 .build())
         .logConfiguration(LogConfigurationProperty.builder()
                 .percentEnabled(123)
                 // the properties below are optional
                 .adsInteractionLog(AdsInteractionLogProperty.builder()
                         .excludeEventTypes(List.of("excludeEventTypes"))
                         .publishOptInEventTypes(List.of("publishOptInEventTypes"))
                         .build())
                 .enabledLoggingStrategies(List.of("enabledLoggingStrategies"))
                 .manifestServiceInteractionLog(ManifestServiceInteractionLogProperty.builder()
                         .excludeEventTypes(List.of("excludeEventTypes"))
                         .build())
                 .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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)
      Create a new AWS::MediaTailor::PlaybackConfiguration.

      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

    • arnForPlaybackConfiguration

      @Stability(Stable) @NotNull public static String arnForPlaybackConfiguration(@NotNull IPlaybackConfigurationRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnPlaybackConfiguration

      @Stability(Stable) @NotNull public static Boolean isCfnPlaybackConfiguration(@NotNull Object x)
      Checks whether the given object is a CfnPlaybackConfiguration.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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 class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDashConfigurationManifestEndpointPrefix

      @Stability(Stable) @NotNull public String 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

      @Stability(Stable) @NotNull public String getAttrHlsConfigurationManifestEndpointPrefix()
      The URL that is used to initiate a playback session for devices that support Apple HLS.

      The session uses server-side reporting.

    • getAttrPlaybackConfigurationArn

      @Stability(Stable) @NotNull public String getAttrPlaybackConfigurationArn()
      The Amazon Resource Name (ARN) for the playback configuration.

    • getAttrPlaybackEndpointPrefix

      @Stability(Stable) @NotNull public String getAttrPlaybackEndpointPrefix()
      The URL that the player accesses to get a manifest from MediaTailor .

      This session will use server-side reporting.

    • getAttrSessionInitializationEndpointPrefix

      @Stability(Stable) @NotNull public String getAttrSessionInitializationEndpointPrefix()
      The URL that the player uses to initialize a session that uses client-side reporting.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPlaybackConfigurationRef

      @Stability(Stable) @NotNull public PlaybackConfigurationReference getPlaybackConfigurationRef()
      A reference to a PlaybackConfiguration resource.
      Specified by:
      getPlaybackConfigurationRef in interface IPlaybackConfigurationRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAdDecisionServerUrl

      @Stability(Stable) @NotNull public String getAdDecisionServerUrl()
      The URL for the ad decision server (ADS).

    • setAdDecisionServerUrl

      @Stability(Stable) public void setAdDecisionServerUrl(@NotNull String value)
      The URL for the ad decision server (ADS).

    • getName

      @Stability(Stable) @NotNull public String getName()
      The identifier for the playback configuration.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The identifier for the playback configuration.

    • getVideoContentSourceUrl

      @Stability(Stable) @NotNull public String getVideoContentSourceUrl()
      The URL prefix for the parent manifest for the stream, minus the asset ID.

    • setVideoContentSourceUrl

      @Stability(Stable) public void setVideoContentSourceUrl(@NotNull String value)
      The URL prefix for the parent manifest for the stream, minus the asset ID.

    • getAdConditioningConfiguration

      @Stability(Stable) @Nullable public Object getAdConditioningConfiguration()
      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 union: either IResolvable or CfnPlaybackConfiguration.AdConditioningConfigurationProperty

    • setAdConditioningConfiguration

      @Stability(Stable) public void setAdConditioningConfiguration(@Nullable IResolvable value)
      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.

    • setAdConditioningConfiguration

      @Stability(Stable) public void setAdConditioningConfiguration(@Nullable CfnPlaybackConfiguration.AdConditioningConfigurationProperty value)
      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.

    • getAvailSuppression

      @Stability(Stable) @Nullable public Object getAvailSuppression()
      The configuration for avail suppression, also known as ad suppression.

      Returns union: either IResolvable or CfnPlaybackConfiguration.AvailSuppressionProperty

    • setAvailSuppression

      @Stability(Stable) public void setAvailSuppression(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public Object getBumper()
      The configuration for bumpers.

      Returns union: either IResolvable or CfnPlaybackConfiguration.BumperProperty

    • setBumper

      @Stability(Stable) public void setBumper(@Nullable IResolvable value)
      The configuration for bumpers.

    • setBumper

      @Stability(Stable) public void setBumper(@Nullable CfnPlaybackConfiguration.BumperProperty value)
      The configuration for bumpers.

    • getCdnConfiguration

      @Stability(Stable) @Nullable public Object getCdnConfiguration()
      The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

      Returns union: either IResolvable or CfnPlaybackConfiguration.CdnConfigurationProperty

    • setCdnConfiguration

      @Stability(Stable) public void setCdnConfiguration(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public Object getConfigurationAliases()
      The player parameters and aliases used as dynamic variables during session initialization.

      Returns union: either Mapinvalid input: '<'String, Object> or IResolvable

    • setConfigurationAliases

      @Stability(Stable) public void setConfigurationAliases(@Nullable Map<String,Object> value)
      The player parameters and aliases used as dynamic variables during session initialization.

    • setConfigurationAliases

      @Stability(Stable) public void setConfigurationAliases(@Nullable IResolvable value)
      The player parameters and aliases used as dynamic variables during session initialization.

    • getDashConfiguration

      @Stability(Stable) @Nullable public Object getDashConfiguration()
      The configuration for a DASH source.

      Returns union: either IResolvable or CfnPlaybackConfiguration.DashConfigurationProperty

    • setDashConfiguration

      @Stability(Stable) public void setDashConfiguration(@Nullable IResolvable value)
      The configuration for a DASH source.

    • setDashConfiguration

      @Stability(Stable) public void setDashConfiguration(@Nullable CfnPlaybackConfiguration.DashConfigurationProperty value)
      The configuration for a DASH source.

    • getHlsConfiguration

      @Stability(Stable) @Nullable public Object getHlsConfiguration()
      The configuration for HLS content.

      Returns union: either IResolvable or CfnPlaybackConfiguration.HlsConfigurationProperty

    • setHlsConfiguration

      @Stability(Stable) public void setHlsConfiguration(@Nullable IResolvable value)
      The configuration for HLS content.

    • setHlsConfiguration

      @Stability(Stable) public void setHlsConfiguration(@Nullable CfnPlaybackConfiguration.HlsConfigurationProperty value)
      The configuration for HLS content.

    • getInsertionMode

      @Stability(Stable) @Nullable public String getInsertionMode()
      The setting that controls whether players can use stitched or guided ad insertion.

    • setInsertionMode

      @Stability(Stable) public void setInsertionMode(@Nullable String value)
      The setting that controls whether players can use stitched or guided ad insertion.

    • getLivePreRollConfiguration

      @Stability(Stable) @Nullable public Object getLivePreRollConfiguration()
      The configuration for pre-roll ad insertion.

      Returns union: either IResolvable or CfnPlaybackConfiguration.LivePreRollConfigurationProperty

    • setLivePreRollConfiguration

      @Stability(Stable) public void setLivePreRollConfiguration(@Nullable IResolvable value)
      The configuration for pre-roll ad insertion.

    • setLivePreRollConfiguration

      @Stability(Stable) public void setLivePreRollConfiguration(@Nullable CfnPlaybackConfiguration.LivePreRollConfigurationProperty value)
      The configuration for pre-roll ad insertion.

    • getLogConfiguration

      @Stability(Stable) @Nullable public Object getLogConfiguration()
      Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

      Returns union: either IResolvable or CfnPlaybackConfiguration.LogConfigurationProperty

    • setLogConfiguration

      @Stability(Stable) public void setLogConfiguration(@Nullable IResolvable value)
      Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

    • setLogConfiguration

      @Stability(Stable) public void setLogConfiguration(@Nullable CfnPlaybackConfiguration.LogConfigurationProperty value)
      Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

    • getManifestProcessingRules

      @Stability(Stable) @Nullable public Object getManifestProcessingRules()
      The configuration for manifest processing rules.

      Returns union: either IResolvable or CfnPlaybackConfiguration.ManifestProcessingRulesProperty

    • setManifestProcessingRules

      @Stability(Stable) public void setManifestProcessingRules(@Nullable IResolvable value)
      The configuration for manifest processing rules.

    • setManifestProcessingRules

      @Stability(Stable) public void setManifestProcessingRules(@Nullable CfnPlaybackConfiguration.ManifestProcessingRulesProperty value)
      The configuration for manifest processing rules.

    • getPersonalizationThresholdSeconds

      @Stability(Stable) @Nullable public Number getPersonalizationThresholdSeconds()
      Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.

    • setPersonalizationThresholdSeconds

      @Stability(Stable) public void setPersonalizationThresholdSeconds(@Nullable Number value)
      Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.

    • getSlateAdUrl

      @Stability(Stable) @Nullable public String getSlateAdUrl()
      The URL for a video asset to transcode and use to fill in time that's not used by ads.

    • setSlateAdUrl

      @Stability(Stable) public void setSlateAdUrl(@Nullable String value)
      The URL for a video asset to transcode and use to fill in time that's not used by ads.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags to assign to the playback configuration.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags to assign to the playback configuration.

    • getTranscodeProfileName

      @Stability(Stable) @Nullable public String getTranscodeProfileName()
      The name that is used to associate this playback configuration with a custom transcode profile.

    • setTranscodeProfileName

      @Stability(Stable) public void setTranscodeProfileName(@Nullable String value)
      The name that is used to associate this playback configuration with a custom transcode profile.