Skip to content
v2.275.0

PrefetchRetrievalProperty Struct ​

Example ​

ts
// 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 ​

dynamicVariablesoptionalIResolvable | { [key: string]: string }dynamic_variablesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]dynamicVariablesoptionalIResolvableDynamicVariablesoptionalIResolvableDynamicVariablesoptionalinterface{}#
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
endTimestringend_timestrendTimeStringEndTimestringEndTime*stringrequired#
The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time.
startTimeoptionalstringstart_timeoptionalstrstartTimeoptionalStringStartTimeoptionalstringStartTimeoptional*string#
The time when prefetch retrievals can start for this break, as an ISO 8601 date-time.
trafficShapingRetrievalWindowoptionalIResolvable | CfnPrefetchSchedule.TrafficShapingRetrievalWindowPropertytraffic_shaping_retrieval_windowoptionaltyping.Union[IResolvable, TrafficShapingRetrievalWindowProperty]trafficShapingRetrievalWindowoptionalIResolvableTrafficShapingRetrievalWindowoptionalIResolvableTrafficShapingRetrievalWindowoptionalinterface{}#
trafficShapingTpsConfigurationoptionalIResolvable | CfnPrefetchSchedule.TrafficShapingTpsConfigurationPropertytraffic_shaping_tps_configurationoptionaltyping.Union[IResolvable, TrafficShapingTpsConfigurationProperty]trafficShapingTpsConfigurationoptionalIResolvableTrafficShapingTpsConfigurationoptionalIResolvableTrafficShapingTpsConfigurationoptionalinterface{}#
trafficShapingTypeoptionalstringtraffic_shaping_typeoptionalstrtrafficShapingTypeoptionalStringTrafficShapingTypeoptionalstringTrafficShapingTypeoptional*string#
Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.