Package software.amazon.awscdk.services.mediatailor

Class CfnPrefetchSchedule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.mediatailor.CfnPrefetchSchedule
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPrefetchScheduleRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:14.123Z") @Stability(Stable) public class CfnPrefetchSchedule extends CfnResource implements IInspectable, IPrefetchScheduleRef, ITaggableV2
Definition of AWS::MediaTailor::PrefetchSchedule Resource Type.

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.*;
 CfnPrefetchSchedule cfnPrefetchSchedule = CfnPrefetchSchedule.Builder.create(this, "MyCfnPrefetchSchedule")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPrefetchSchedule

      protected CfnPrefetchSchedule(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPrefetchSchedule

      protected CfnPrefetchSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPrefetchSchedule

      @Stability(Stable) public CfnPrefetchSchedule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPrefetchScheduleProps props)
      Create a new AWS::MediaTailor::PrefetchSchedule.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForPrefetchSchedule

      @Stability(Stable) @NotNull public static String arnForPrefetchSchedule(@NotNull IPrefetchScheduleRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnPrefetchSchedule

      @Stability(Stable) @NotNull public static Boolean isCfnPrefetchSchedule(@NotNull Object x)
      Checks whether the given object is a CfnPrefetchSchedule.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the prefetch schedule.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getPrefetchScheduleRef

      @Stability(Stable) @NotNull public PrefetchScheduleReference getPrefetchScheduleRef()
      A reference to a PrefetchSchedule resource.
      Specified by:
      getPrefetchScheduleRef in interface IPrefetchScheduleRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name to assign to the prefetch schedule.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name to assign to the prefetch schedule.

    • getPlaybackConfigurationName

      @Stability(Stable) @NotNull public String getPlaybackConfigurationName()
      The name of the playback configuration.

    • setPlaybackConfigurationName

      @Stability(Stable) public void setPlaybackConfigurationName(@NotNull String value)
      The name of the playback configuration.

    • getConsumption

      @Stability(Stable) @Nullable public Object getConsumption()
      Returns union: either IResolvable or CfnPrefetchSchedule.PrefetchConsumptionProperty

    • setConsumption

      @Stability(Stable) public void setConsumption(@Nullable IResolvable value)

    • setConsumption

      @Stability(Stable) public void setConsumption(@Nullable CfnPrefetchSchedule.PrefetchConsumptionProperty value)

    • getRecurringPrefetchConfiguration

      @Stability(Stable) @Nullable public Object getRecurringPrefetchConfiguration()
      Returns union: either IResolvable or CfnPrefetchSchedule.RecurringPrefetchConfigurationProperty

    • setRecurringPrefetchConfiguration

      @Stability(Stable) public void setRecurringPrefetchConfiguration(@Nullable IResolvable value)

    • setRecurringPrefetchConfiguration

      @Stability(Stable) public void setRecurringPrefetchConfiguration(@Nullable CfnPrefetchSchedule.RecurringPrefetchConfigurationProperty value)

    • getRetrieval

      @Stability(Stable) @Nullable public Object getRetrieval()
      Returns union: either IResolvable or CfnPrefetchSchedule.PrefetchRetrievalProperty

    • setRetrieval

      @Stability(Stable) public void setRetrieval(@Nullable IResolvable value)

    • setRetrieval

      @Stability(Stable) public void setRetrieval(@Nullable CfnPrefetchSchedule.PrefetchRetrievalProperty value)

    • getScheduleType

      @Stability(Stable) @Nullable public String getScheduleType()
      The frequency that MediaTailor creates prefetch schedules.

    • setScheduleType

      @Stability(Stable) public void setScheduleType(@Nullable String value)
      The frequency that MediaTailor creates prefetch schedules.

    • getStreamId

      @Stability(Stable) @Nullable public String getStreamId()
      An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.

    • setStreamId

      @Stability(Stable) public void setStreamId(@Nullable String value)
      An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags assigned to the prefetch schedule.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags assigned to the prefetch schedule.