View a markdown version of this page

AWS::MediaTailor::PrefetchSchedule - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::MediaTailor::PrefetchSchedule

A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

Syntax

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

JSON

{
  "Type" : "AWS::MediaTailor::PrefetchSchedule",
  "Properties" : {
      "Consumption" : PrefetchConsumption,
      "Name" : String,
      "PlaybackConfigurationName" : String,
      "RecurringPrefetchConfiguration" : RecurringPrefetchConfiguration,
      "Retrieval" : PrefetchRetrieval,
      "ScheduleType" : String,
      "StreamId" : String,
      "Tags" : [ Tag, ... ]
    }
}

Properties

Consumption

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

Required: No

Type: PrefetchConsumption

Update requires: Replacement

Name

The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

Required: Yes

Type: String

Update requires: Replacement

PlaybackConfigurationName

The name of the playback configuration to create the prefetch schedule for.

Required: Yes

Type: String

Update requires: Replacement

RecurringPrefetchConfiguration

The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.

Required: No

Type: RecurringPrefetchConfiguration

Update requires: Replacement

Retrieval

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

Required: No

Type: PrefetchRetrieval

Update requires: Replacement

ScheduleType

The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

For more information about the prefetch types and when you might use each, see Prefetching ads in AWS Elemental MediaTailor.

Required: No

Type: String

Allowed values: SINGLE | RECURRING

Update requires: Replacement

StreamId

An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

Required: No

Type: String

Update requires: Replacement

Tags

The tags assigned to the prefetch schedule. 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

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the prefetch schedule.