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 PrefetchRetrieval
A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "DynamicVariables" :{, "EndTime" :Key:Value, ...}String, "StartTime" :String, "TrafficShapingRetrievalWindow" :TrafficShapingRetrievalWindow, "TrafficShapingTpsConfiguration" :TrafficShapingTpsConfiguration, "TrafficShapingType" :String}
YAML
DynamicVariables:EndTime:Key:ValueStringStartTime:StringTrafficShapingRetrievalWindow:TrafficShapingRetrievalWindowTrafficShapingTpsConfiguration:TrafficShapingTpsConfigurationTrafficShapingType:String
Properties
DynamicVariables-
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify
DynamicVariablesfor prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.Required: No
Type: Object of String
Pattern:
.+Update requires: Replacement
EndTime-
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
Required: Yes
Type: String
Update requires: Replacement
StartTime-
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
Required: No
Type: String
Update requires: Replacement
TrafficShapingRetrievalWindow-
The configuration that tells AWS Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
Required: No
Type: TrafficShapingRetrievalWindow
Update requires: Replacement
TrafficShapingTpsConfiguration-
The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
Required: No
Type: TrafficShapingTpsConfiguration
Update requires: Replacement
TrafficShapingType-
Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.
Required: No
Type: String
Allowed values:
RETRIEVAL_WINDOW | TPSUpdate requires: Replacement
