CfnPrefetchScheduleProps Struct
Properties for defining a CfnPrefetchSchedule.
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 cfnPrefetchScheduleProps: mediatailor.CfnPrefetchScheduleProps = {
name: 'name',
playbackConfigurationName: 'playbackConfigurationName',
// the properties below are optional
consumption: {
endTime: 'endTime',
// the properties below are optional
availMatchingCriteria: [{
dynamicVariable: 'dynamicVariable',
operator: 'operator',
}],
startTime: 'startTime',
},
recurringPrefetchConfiguration: {
endTime: 'endTime',
recurringConsumption: {
availMatchingCriteria: [{
dynamicVariable: 'dynamicVariable',
operator: 'operator',
}],
retrievedAdExpirationSeconds: 123,
},
recurringRetrieval: {
delayAfterAvailEndSeconds: 123,
dynamicVariables: {
dynamicVariablesKey: 'dynamicVariables',
},
trafficShapingRetrievalWindow: {
retrievalWindowDurationSeconds: 123,
},
trafficShapingTpsConfiguration: {
peakConcurrentUsers: 123,
peakTps: 123,
},
trafficShapingType: 'trafficShapingType',
},
// the properties below are optional
startTime: 'startTime',
},
retrieval: {
endTime: 'endTime',
// the properties below are optional
dynamicVariables: {
dynamicVariablesKey: 'dynamicVariables',
},
startTime: 'startTime',
trafficShapingRetrievalWindow: {
retrievalWindowDurationSeconds: 123,
},
trafficShapingTpsConfiguration: {
peakConcurrentUsers: 123,
peakTps: 123,
},
trafficShapingType: 'trafficShapingType',
},
scheduleType: 'scheduleType',
streamId: 'streamId',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
consumptionoptionalIResolvable | CfnPrefetchSchedule.PrefetchConsumptionPropertyconsumptionoptionaltyping.Union[IResolvable, PrefetchConsumptionProperty]consumptionoptionalIResolvableConsumptionoptionalIResolvableConsumptionoptionalinterface{}#The name to assign to the prefetch schedule.
playbackConfigurationNamestringplayback_configuration_namestrplaybackConfigurationNameStringPlaybackConfigurationNamestringPlaybackConfigurationName*stringrequired#The name of the playback configuration.
recurringPrefetchConfigurationoptionalIResolvable | CfnPrefetchSchedule.RecurringPrefetchConfigurationPropertyrecurring_prefetch_configurationoptionaltyping.Union[IResolvable, RecurringPrefetchConfigurationProperty]recurringPrefetchConfigurationoptionalIResolvableRecurringPrefetchConfigurationoptionalIResolvableRecurringPrefetchConfigurationoptionalinterface{}#retrievaloptionalIResolvable | CfnPrefetchSchedule.PrefetchRetrievalPropertyretrievaloptionaltyping.Union[IResolvable, PrefetchRetrievalProperty]retrievaloptionalIResolvableRetrievaloptionalIResolvableRetrievaloptionalinterface{}#scheduleTypeoptionalstringschedule_typeoptionalstrscheduleTypeoptionalStringScheduleTypeoptionalstringScheduleTypeoptional*string#The frequency that MediaTailor creates prefetch schedules.
streamIdoptionalstringstream_idoptionalstrstreamIdoptionalStringStreamIdoptionalstringStreamIdoptional*string#An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.