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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:09.988Z") @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()
                 .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:

  • 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)
      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

      @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

    • 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.

    • getAvailSuppression

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

    • 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.

    • 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.

    • 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.

    • setConfigurationAliases

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

    • setConfigurationAliases

      @Stability(Stable) public void setConfigurationAliases(@Nullable Map<String,Object> 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.

    • 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.

    • 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.

    • getLivePreRollConfiguration

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

    • 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.

    • getManifestProcessingRules

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

    • 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.