Package software.amazon.awscdk.services.mediatailor

Interface CfnPrefetchScheduleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPrefetchScheduleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:14.128Z")
@Stability(Stable)
public interface CfnPrefetchScheduleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPrefetchSchedule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediatailor.*;
 CfnPrefetchScheduleProps cfnPrefetchScheduleProps = CfnPrefetchScheduleProps.builder()
         .name("name")
         .playbackConfigurationName("playbackConfigurationName")
         // the properties below are optional
         .consumption(PrefetchConsumptionProperty.builder()
                 .endTime("endTime")
                 // the properties below are optional
                 .availMatchingCriteria(List.of(AvailMatchingCriteriaProperty.builder()
                         .dynamicVariable("dynamicVariable")
                         .operator("operator")
                         .build()))
                 .startTime("startTime")
                 .build())
         .recurringPrefetchConfiguration(RecurringPrefetchConfigurationProperty.builder()
                 .endTime("endTime")
                 .recurringConsumption(RecurringConsumptionProperty.builder()
                         .availMatchingCriteria(List.of(AvailMatchingCriteriaProperty.builder()
                                 .dynamicVariable("dynamicVariable")
                                 .operator("operator")
                                 .build()))
                         .retrievedAdExpirationSeconds(123)
                         .build())
                 .recurringRetrieval(RecurringRetrievalProperty.builder()
                         .delayAfterAvailEndSeconds(123)
                         .dynamicVariables(Map.of(
                                 "dynamicVariablesKey", "dynamicVariables"))
                         .trafficShapingRetrievalWindow(TrafficShapingRetrievalWindowProperty.builder()
                                 .retrievalWindowDurationSeconds(123)
                                 .build())
                         .trafficShapingTpsConfiguration(TrafficShapingTpsConfigurationProperty.builder()
                                 .peakConcurrentUsers(123)
                                 .peakTps(123)
                                 .build())
                         .trafficShapingType("trafficShapingType")
                         .build())
                 // the properties below are optional
                 .startTime("startTime")
                 .build())
         .retrieval(PrefetchRetrievalProperty.builder()
                 .endTime("endTime")
                 // the properties below are optional
                 .dynamicVariables(Map.of(
                         "dynamicVariablesKey", "dynamicVariables"))
                 .startTime("startTime")
                 .trafficShapingRetrievalWindow(TrafficShapingRetrievalWindowProperty.builder()
                         .retrievalWindowDurationSeconds(123)
                         .build())
                 .trafficShapingTpsConfiguration(TrafficShapingTpsConfigurationProperty.builder()
                         .peakConcurrentUsers(123)
                         .peakTps(123)
                         .build())
                 .trafficShapingType("trafficShapingType")
                 .build())
         .scheduleType("scheduleType")
         .streamId("streamId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPrefetchScheduleProps.Builder	A builder for CfnPrefetchScheduleProps
static final class	CfnPrefetchScheduleProps.Jsii$Proxy	An implementation for CfnPrefetchScheduleProps

Method Summary

Modifier and Type	Method	Description
static CfnPrefetchScheduleProps.Builder	builder()
default Object	getConsumption()	Returns union: either IResolvable or CfnPrefetchSchedule.PrefetchConsumptionProperty
String	getName()	The name to assign to the prefetch schedule.
String	getPlaybackConfigurationName()	The name of the playback configuration.
default Object	getRecurringPrefetchConfiguration()	Returns union: either IResolvable or CfnPrefetchSchedule.RecurringPrefetchConfigurationProperty
default Object	getRetrieval()	Returns union: either IResolvable or CfnPrefetchSchedule.PrefetchRetrievalProperty
default String	getScheduleType()	The frequency that MediaTailor creates prefetch schedules.
default String	getStreamId()	An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.
default List<CfnTag>	getTags()	The tags assigned to the prefetch schedule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name to assign to the prefetch schedule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-name

getPlaybackConfigurationName

@Stability(Stable)
@NotNull
String getPlaybackConfigurationName()

The name of the playback configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-playbackconfigurationname

getConsumption

@Stability(Stable)
@Nullable
default Object getConsumption()

Returns union: either IResolvable or CfnPrefetchSchedule.PrefetchConsumptionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-consumption

getRecurringPrefetchConfiguration

@Stability(Stable)
@Nullable
default Object getRecurringPrefetchConfiguration()

Returns union: either IResolvable or CfnPrefetchSchedule.RecurringPrefetchConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-recurringprefetchconfiguration

getRetrieval

@Stability(Stable)
@Nullable
default Object getRetrieval()

Returns union: either IResolvable or CfnPrefetchSchedule.PrefetchRetrievalProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-retrieval

getScheduleType

@Stability(Stable)
@Nullable
default String getScheduleType()

The frequency that MediaTailor creates prefetch schedules.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-scheduletype

getStreamId

@Stability(Stable)
@Nullable
default String getStreamId()

An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-streamid

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags assigned to the prefetch schedule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-tags

builder

@Stability(Stable)
static CfnPrefetchScheduleProps.Builder builder()

Returns:

a CfnPrefetchScheduleProps.Builder of CfnPrefetchScheduleProps