Package software.amazon.awscdk.services.mediatailor

Interface CfnPrefetchSchedule.PrefetchRetrievalProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPrefetchSchedule.PrefetchRetrievalProperty.Jsii$Proxy

Enclosing class:

CfnPrefetchSchedule

@Stability(Stable)
public static interface CfnPrefetchSchedule.PrefetchRetrievalProperty
extends software.amazon.jsii.JsiiSerializable

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.*;
 PrefetchRetrievalProperty prefetchRetrievalProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPrefetchSchedule.PrefetchRetrievalProperty.Builder	builder()
default Object	getDynamicVariables()	The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
String	getEndTime()	The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time.
default String	getStartTime()	The time when prefetch retrievals can start for this break, as an ISO 8601 date-time.
default Object	getTrafficShapingRetrievalWindow()	Returns union: either IResolvable or CfnPrefetchSchedule.TrafficShapingRetrievalWindowProperty
default Object	getTrafficShapingTpsConfiguration()	Returns union: either IResolvable or CfnPrefetchSchedule.TrafficShapingTpsConfigurationProperty
default String	getTrafficShapingType()	Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndTime

@Stability(Stable)
@NotNull
String getEndTime()

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

getDynamicVariables

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

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

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

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

getStartTime

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

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

getTrafficShapingRetrievalWindow

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

Returns union: either IResolvable or CfnPrefetchSchedule.TrafficShapingRetrievalWindowProperty

See Also:

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

getTrafficShapingTpsConfiguration

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

Returns union: either IResolvable or CfnPrefetchSchedule.TrafficShapingTpsConfigurationProperty

See Also:

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

getTrafficShapingType

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

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

builder

@Stability(Stable)
static CfnPrefetchSchedule.PrefetchRetrievalProperty.Builder builder()

Returns:

a CfnPrefetchSchedule.PrefetchRetrievalProperty.Builder of CfnPrefetchSchedule.PrefetchRetrievalProperty