AWS::MediaTailor::PlaybackConfiguration - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::MediaTailor::PlaybackConfiguration

Adds a new playback configuration to AWS Elemental MediaTailor.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::MediaTailor::PlaybackConfiguration",
  "Properties" : {
      "AdDecisionServerUrl" : String,
      "AvailSuppression" : AvailSuppression,
      "Bumper" : Bumper,
      "CdnConfiguration" : CdnConfiguration,
      "ConfigurationAliases" : {Key: Value, ...},
      "DashConfiguration" : DashConfiguration,
      "HlsConfiguration" : HlsConfiguration,
      "LivePreRollConfiguration" : LivePreRollConfiguration,
      "ManifestProcessingRules" : ManifestProcessingRules,
      "Name" : String,
      "PersonalizationThresholdSeconds" : Integer,
      "SlateAdUrl" : String,
      "Tags" : [ Tag, ... ],
      "TranscodeProfileName" : String,
      "VideoContentSourceUrl" : String
    }
}

Properties

AdDecisionServerUrl

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.

Required: Yes

Type: String

Update requires: No interruption

AvailSuppression

The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

Required: No

Type: AvailSuppression

Update requires: No interruption

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.

Required: No

Type: Bumper

Update requires: No interruption

CdnConfiguration

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

Required: No

Type: CdnConfiguration

Update requires: No interruption

ConfigurationAliases

The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

Required: No

Type: Object

Pattern: player_params\.\w+\Z

Update requires: No interruption

DashConfiguration

The configuration for a DASH source.

Required: No

Type: DashConfiguration

Update requires: No interruption

HlsConfiguration

The configuration for HLS content.

Required: No

Type: HlsConfiguration

Update requires: No interruption

LivePreRollConfiguration

The configuration for pre-roll ad insertion.

Required: No

Type: LivePreRollConfiguration

Update requires: No interruption

ManifestProcessingRules

The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Required: No

Type: ManifestProcessingRules

Update requires: No interruption

Name

The identifier for the playback configuration.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

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

Required: No

Type: Integer

Update requires: No interruption

SlateAdUrl

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.

Required: No

Type: String

Update requires: No interruption

Tags

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.

Required: No

Type: Array of Tag

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

VideoContentSourceUrl

The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

Required: Yes

Type: String

Update requires: No interruption

Return values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

DashConfiguration.ManifestEndpointPrefix

The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.

HlsConfiguration.ManifestEndpointPrefix

The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.

PlaybackConfigurationArn

The Amazon Resource Name (ARN) for the playback configuration.

PlaybackEndpointPrefix

The URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.

SessionInitializationEndpointPrefix

The URL that the player uses to initialize a session that uses client-side reporting.