interface CfnPlaybackConfigurationProps

Language	Type name
.NET	`Amazon.CDK.AWS.MediaTailor.CfnPlaybackConfigurationProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmediatailor#CfnPlaybackConfigurationProps`
Java	`software.amazon.awscdk.services.mediatailor.CfnPlaybackConfigurationProps`
Python	`aws_cdk.aws_mediatailor.CfnPlaybackConfigurationProps`
TypeScript	`aws-cdk-lib` » `aws_mediatailor` » `CfnPlaybackConfigurationProps`

Properties for defining a CfnPlaybackConfiguration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediatailor as mediatailor } from 'aws-cdk-lib';

declare const configurationAliases: any;
const cfnPlaybackConfigurationProps: mediatailor.CfnPlaybackConfigurationProps = {
  adDecisionServerUrl: 'adDecisionServerUrl',
  name: 'name',
  videoContentSourceUrl: 'videoContentSourceUrl',

  // the properties below are optional
  availSuppression: {
    fillPolicy: 'fillPolicy',
    mode: 'mode',
    value: 'value',
  },
  bumper: {
    endUrl: 'endUrl',
    startUrl: 'startUrl',
  },
  cdnConfiguration: {
    adSegmentUrlPrefix: 'adSegmentUrlPrefix',
    contentSegmentUrlPrefix: 'contentSegmentUrlPrefix',
  },
  configurationAliases: {
    configurationAliasesKey: configurationAliases,
  },
  dashConfiguration: {
    manifestEndpointPrefix: 'manifestEndpointPrefix',
    mpdLocation: 'mpdLocation',
    originManifestType: 'originManifestType',
  },
  hlsConfiguration: {
    manifestEndpointPrefix: 'manifestEndpointPrefix',
  },
  livePreRollConfiguration: {
    adDecisionServerUrl: 'adDecisionServerUrl',
    maxDurationSeconds: 123,
  },
  manifestProcessingRules: {
    adMarkerPassthrough: {
      enabled: false,
    },
  },
  personalizationThresholdSeconds: 123,
  slateAdUrl: 'slateAdUrl',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  transcodeProfileName: 'transcodeProfileName',
};

Properties

Name	Type	Description
adDecisionServerUrl	`string`	The URL for the ad decision server (ADS).
name	`string`	The identifier for the playback configuration.
videoContentSourceUrl	`string`	The URL prefix for the parent manifest for the stream, minus the asset ID.
availSuppression?	`IResolvable` `\|` `AvailSuppressionProperty`	The configuration for avail suppression, also known as ad suppression.
bumper?	`IResolvable` `\|` `BumperProperty`	The configuration for bumpers.
cdnConfiguration?	`IResolvable` `\|` `CdnConfigurationProperty`	The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
configurationAliases?	`IResolvable` `\| { [string]: any }`	The player parameters and aliases used as dynamic variables during session initialization.
dashConfiguration?	`IResolvable` `\|` `DashConfigurationProperty`	The configuration for a DASH source.
hlsConfiguration?	`IResolvable` `\|` `HlsConfigurationProperty`	The configuration for HLS content.
livePreRollConfiguration?	`IResolvable` `\|` `LivePreRollConfigurationProperty`	The configuration for pre-roll ad insertion.
manifestProcessingRules?	`IResolvable` `\|` `ManifestProcessingRulesProperty`	The configuration for manifest processing rules.
personalizationThresholdSeconds?	`number`	Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
slateAdUrl?	`string`	The URL for a video asset to transcode and use to fill in time that's not used by ads.
tags?	`CfnTag[]`	The tags to assign to the playback configuration.
transcodeProfileName?	`string`	The name that is used to associate this playback configuration with a custom transcode profile.

adDecisionServerUrl

Type: string

The URL for the ad decision server (ADS).

This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental 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.

name

Type: string

The identifier for the playback configuration.

videoContentSourceUrl

Type: string

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

The maximum length is 512 characters.

availSuppression?

Type: IResolvable | AvailSuppressionProperty (optional)

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

For more information about ad suppression, see Ad Suppression .

bumper?

Type: IResolvable | BumperProperty (optional)

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 .

cdnConfiguration?

Type: IResolvable | CdnConfigurationProperty (optional)

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

configurationAliases?

Type: IResolvable | { [string]: any } (optional)

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

For more information, see Domain Variables .

dashConfiguration?

Type: IResolvable | DashConfigurationProperty (optional)

The configuration for a DASH source.

hlsConfiguration?

Type: IResolvable | HlsConfigurationProperty (optional)

The configuration for HLS content.

livePreRollConfiguration?

Type: IResolvable | LivePreRollConfigurationProperty (optional)

The configuration for pre-roll ad insertion.

manifestProcessingRules?

Type: IResolvable | ManifestProcessingRulesProperty (optional)

The configuration for manifest processing rules.

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

personalizationThresholdSeconds?

Type: number (optional)

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 AWS Elemental MediaTailor .

slateAdUrl?

Type: string (optional)

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

AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

tags?

Type: CfnTag[] (optional)

The tags to assign to the playback configuration.

Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .

transcodeProfileName?

Type: string (optional)

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.