View a markdown version of this page

AWS::IVS::AdConfiguration - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::IVS::AdConfiguration

Object specifying a configuration for a server-side advertising insertion (which can be triggered with the API_InsertAdBreak operation).

Syntax

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

JSON

{
  "Type" : "AWS::IVS::AdConfiguration",
  "Properties" : {
      "MediaTailorPlaybackConfigurations" : [ MediaTailorPlaybackConfiguration, ... ],
      "Name" : String,
      "PostRollConfiguration" : PostRollConfiguration,
      "Tags" : [ Tag, ... ]
    }
}

Properties

MediaTailorPlaybackConfigurations

List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens.

Required: Yes

Type: Array of MediaTailorPlaybackConfiguration

Minimum: 1

Maximum: 3

Update requires: No interruption

Name

Ad configuration name. Defaults to “”.

Required: No

Type: String

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

Minimum: 0

Maximum: 128

Update requires: No interruption

PostRollConfiguration

Configuration for the post-roll ad break to use for this ad configuration.

Required: No

Type: PostRollConfiguration

Update requires: No interruption

Tags

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Ad configuration ARN.