interface PrefetchRetrievalProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.MediaTailor.CfnPrefetchSchedulePropsMixin.PrefetchRetrievalProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsmediatailor#CfnPrefetchSchedulePropsMixin_PrefetchRetrievalProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.mediatailor.CfnPrefetchSchedulePropsMixin.PrefetchRetrievalProperty
Python	aws_cdk.cfn_property_mixins.aws_mediatailor.CfnPrefetchSchedulePropsMixin.PrefetchRetrievalProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_mediatailor » CfnPrefetchSchedulePropsMixin » PrefetchRetrievalProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html

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/cfn-property-mixins';
const prefetchRetrievalProperty: mediatailor.CfnPrefetchSchedulePropsMixin.PrefetchRetrievalProperty = {
  dynamicVariables: {
    dynamicVariablesKey: 'dynamicVariables',
  },
  endTime: 'endTime',
  startTime: 'startTime',
  trafficShapingRetrievalWindow: {
    retrievalWindowDurationSeconds: 123,
  },
  trafficShapingTpsConfiguration: {
    peakConcurrentUsers: 123,
    peakTps: 123,
  },
  trafficShapingType: 'trafficShapingType',
};

Properties

Name	Type	Description
dynamicVariables?	IResolvable | { [string]: string }	The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
endTime?	string	The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time.
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.

---

dynamicVariables?

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-dynamicvariables

---

endTime?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-endtime

---

startTime?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-starttime

---

trafficShapingRetrievalWindow?

Type: IResolvable | TrafficShapingRetrievalWindowProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-trafficshapingretrievalwindow

---

trafficShapingTpsConfiguration?

Type: IResolvable | TrafficShapingTpsConfigurationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-trafficshapingtpsconfiguration

---

trafficShapingType?

Type: string (optional)

Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-trafficshapingtype