software.amazon.awscdk.services.mediatailor

Class CfnPlaybackConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.mediatailor.CfnPlaybackConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPlaybackConfiguration>

Enclosing class:

CfnPlaybackConfiguration

@Stability(value=Stable)
public static final class CfnPlaybackConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPlaybackConfiguration>

A fluent builder for CfnPlaybackConfiguration.

Method Summary

Modifier and Type	Method and Description
CfnPlaybackConfiguration.Builder	adDecisionServerUrl(String adDecisionServerUrl) The URL for the ad decision server (ADS).
CfnPlaybackConfiguration.Builder	availSuppression(CfnPlaybackConfiguration.AvailSuppressionProperty availSuppression) The configuration for avail suppression, also known as ad suppression.
CfnPlaybackConfiguration.Builder	availSuppression(IResolvable availSuppression) The configuration for avail suppression, also known as ad suppression.
CfnPlaybackConfiguration	build()
CfnPlaybackConfiguration.Builder	bumper(CfnPlaybackConfiguration.BumperProperty bumper) The configuration for bumpers.
CfnPlaybackConfiguration.Builder	bumper(IResolvable bumper) The configuration for bumpers.
CfnPlaybackConfiguration.Builder	cdnConfiguration(CfnPlaybackConfiguration.CdnConfigurationProperty cdnConfiguration) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
CfnPlaybackConfiguration.Builder	cdnConfiguration(IResolvable cdnConfiguration) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
CfnPlaybackConfiguration.Builder	configurationAliases(IResolvable configurationAliases) The player parameters and aliases used as dynamic variables during session initialization.
CfnPlaybackConfiguration.Builder	configurationAliases(Map<String,? extends Object> configurationAliases) The player parameters and aliases used as dynamic variables during session initialization.
static CfnPlaybackConfiguration.Builder	create(software.constructs.Construct scope, String id)
CfnPlaybackConfiguration.Builder	dashConfiguration(CfnPlaybackConfiguration.DashConfigurationProperty dashConfiguration) The configuration for DASH content.
CfnPlaybackConfiguration.Builder	dashConfiguration(IResolvable dashConfiguration) The configuration for DASH content.
CfnPlaybackConfiguration.Builder	livePreRollConfiguration(CfnPlaybackConfiguration.LivePreRollConfigurationProperty livePreRollConfiguration) The configuration for pre-roll ad insertion.
CfnPlaybackConfiguration.Builder	livePreRollConfiguration(IResolvable livePreRollConfiguration) The configuration for pre-roll ad insertion.
CfnPlaybackConfiguration.Builder	manifestProcessingRules(CfnPlaybackConfiguration.ManifestProcessingRulesProperty manifestProcessingRules) The configuration for manifest processing rules.
CfnPlaybackConfiguration.Builder	manifestProcessingRules(IResolvable manifestProcessingRules) The configuration for manifest processing rules.
CfnPlaybackConfiguration.Builder	name(String name) The identifier for the playback configuration.
CfnPlaybackConfiguration.Builder	personalizationThresholdSeconds(Number personalizationThresholdSeconds) Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
CfnPlaybackConfiguration.Builder	slateAdUrl(String slateAdUrl) The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
CfnPlaybackConfiguration.Builder	tags(List<? extends CfnTag> tags) The tags to assign to the playback configuration.
CfnPlaybackConfiguration.Builder	transcodeProfileName(String transcodeProfileName) The name that is used to associate this playback configuration with a custom transcode profile.
CfnPlaybackConfiguration.Builder	videoContentSourceUrl(String videoContentSourceUrl) The URL prefix for the parent manifest for the stream, minus the asset ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnPlaybackConfiguration.Builder create(software.constructs.Construct scope,
                                                                               String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnPlaybackConfiguration.AdMarkerPassthroughProperty.Builder.

adDecisionServerUrl

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder adDecisionServerUrl(String adDecisionServerUrl)

The URL for the ad decision server (ADS).

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.

Parameters:

adDecisionServerUrl - The URL for the ad decision server (ADS). This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder name(String name)

The identifier for the playback configuration.

Parameters:

name - The identifier for the playback configuration. This parameter is required.

Returns:

this

videoContentSourceUrl

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder videoContentSourceUrl(String videoContentSourceUrl)

The URL prefix for the parent manifest for the stream, minus the asset ID.

The maximum length is 512 characters.

Parameters:

videoContentSourceUrl - The URL prefix for the parent manifest for the stream, minus the asset ID. This parameter is required.

Returns:

this

availSuppression

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder availSuppression(CfnPlaybackConfiguration.AvailSuppressionProperty availSuppression)

The configuration for avail suppression, also known as ad suppression.

For more information about ad suppression, see Ad Suppression .

Parameters:

availSuppression - The configuration for avail suppression, also known as ad suppression. This parameter is required.

Returns:

this

availSuppression

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder availSuppression(IResolvable availSuppression)

The configuration for avail suppression, also known as ad suppression.

For more information about ad suppression, see Ad Suppression .

Parameters:

availSuppression - The configuration for avail suppression, also known as ad suppression. This parameter is required.

Returns:

this

bumper

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder bumper(CfnPlaybackConfiguration.BumperProperty bumper)

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 .

Parameters:

bumper - The configuration for bumpers. This parameter is required.

Returns:

this

bumper

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder bumper(IResolvable bumper)

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 .

Parameters:

bumper - The configuration for bumpers. This parameter is required.

Returns:

this

cdnConfiguration

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder cdnConfiguration(CfnPlaybackConfiguration.CdnConfigurationProperty cdnConfiguration)

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

Parameters:

cdnConfiguration - The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. This parameter is required.

Returns:

this

cdnConfiguration

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder cdnConfiguration(IResolvable cdnConfiguration)

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

Parameters:

cdnConfiguration - The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. This parameter is required.

Returns:

this

configurationAliases

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder configurationAliases(IResolvable configurationAliases)

The player parameters and aliases used as dynamic variables during session initialization.

For more information, see Domain Variables .

Parameters:

configurationAliases - The player parameters and aliases used as dynamic variables during session initialization. This parameter is required.

Returns:

this

configurationAliases

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder configurationAliases(Map<String,? extends Object> configurationAliases)

The player parameters and aliases used as dynamic variables during session initialization.

For more information, see Domain Variables .

Parameters:

configurationAliases - The player parameters and aliases used as dynamic variables during session initialization. This parameter is required.

Returns:

this

dashConfiguration

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder dashConfiguration(CfnPlaybackConfiguration.DashConfigurationProperty dashConfiguration)

The configuration for DASH content.

Parameters:

dashConfiguration - The configuration for DASH content. This parameter is required.

Returns:

this

dashConfiguration

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder dashConfiguration(IResolvable dashConfiguration)

The configuration for DASH content.

Parameters:

dashConfiguration - The configuration for DASH content. This parameter is required.

Returns:

this

livePreRollConfiguration

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder livePreRollConfiguration(CfnPlaybackConfiguration.LivePreRollConfigurationProperty livePreRollConfiguration)

The configuration for pre-roll ad insertion.

Parameters:

livePreRollConfiguration - The configuration for pre-roll ad insertion. This parameter is required.

Returns:

this

livePreRollConfiguration

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder livePreRollConfiguration(IResolvable livePreRollConfiguration)

The configuration for pre-roll ad insertion.

Parameters:

livePreRollConfiguration - The configuration for pre-roll ad insertion. This parameter is required.

Returns:

this

manifestProcessingRules

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder manifestProcessingRules(CfnPlaybackConfiguration.ManifestProcessingRulesProperty manifestProcessingRules)

The configuration for manifest processing rules.

Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Parameters:

manifestProcessingRules - The configuration for manifest processing rules. This parameter is required.

Returns:

this

manifestProcessingRules

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder manifestProcessingRules(IResolvable manifestProcessingRules)

The configuration for manifest processing rules.

Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Parameters:

manifestProcessingRules - The configuration for manifest processing rules. This parameter is required.

Returns:

this

personalizationThresholdSeconds

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder personalizationThresholdSeconds(Number personalizationThresholdSeconds)

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.

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 .

Parameters:

personalizationThresholdSeconds - Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. This parameter is required.

Returns:

this

slateAdUrl

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder slateAdUrl(String slateAdUrl)

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.

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.

Parameters:

slateAdUrl - The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder tags(List<? extends CfnTag> tags)

The tags to assign to the playback configuration.

Parameters:

tags - The tags to assign to the playback configuration. This parameter is required.

Returns:

this

transcodeProfileName

@Stability(value=Stable)
public CfnPlaybackConfiguration.Builder transcodeProfileName(String transcodeProfileName)

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.

Parameters:

transcodeProfileName - The name that is used to associate this playback configuration with a custom transcode profile. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnPlaybackConfiguration build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPlaybackConfiguration>