interface PrefetchRetrievalProperty

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

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';
const prefetchRetrievalProperty: mediatailor.CfnPrefetchSchedule.PrefetchRetrievalProperty = {
  endTime: 'endTime',

  // the properties below are optional
  dynamicVariables: {
    dynamicVariablesKey: 'dynamicVariables',
  },
  startTime: 'startTime',
  trafficShapingRetrievalWindow: {
    retrievalWindowDurationSeconds: 123,
  },
  trafficShapingTpsConfiguration: {
    peakConcurrentUsers: 123,
    peakTps: 123,
  },
  trafficShapingType: 'trafficShapingType',
};

Properties

Name	Type	Description
endTime	`string`	The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time.
dynamicVariables?	`IResolvable` `\| { [string]: string }`	The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
startTime?	`string`	The time when prefetch retrievals can start for this break, as an ISO 8601 date-time.
trafficShapingRetrievalWindow?	`IResolvable` `\|` `TrafficShapingRetrievalWindowProperty`
trafficShapingTpsConfiguration?	`IResolvable` `\|` `TrafficShapingTpsConfigurationProperty`
trafficShapingType?	`string`	Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.

endTime

Type: string

The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time.

dynamicVariables?

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

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

startTime?

Type: string (optional)

The time when prefetch retrievals can start for this break, as an ISO 8601 date-time.

trafficShapingRetrievalWindow?

Type: IResolvable | TrafficShapingRetrievalWindowProperty (optional)

trafficShapingTpsConfiguration?

Type: IResolvable | TrafficShapingTpsConfigurationProperty (optional)

trafficShapingType?