CfnPrefetchSchedulePropsMixin
- class aws_cdk.cfn_property_mixins.aws_mediatailor.CfnPrefetchSchedulePropsMixin(props, *, strategy=None)
Bases:
MixinDefinition of AWS::MediaTailor::PrefetchSchedule Resource Type.
- See:
- CloudformationResource:
AWS::MediaTailor::PrefetchSchedule
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor import aws_cdk as cdk # merge_strategy: cdk.IMergeStrategy cfn_prefetch_schedule_props_mixin = mediatailor.CfnPrefetchSchedulePropsMixin(mediatailor.CfnPrefetchScheduleMixinProps( consumption=mediatailor.CfnPrefetchSchedulePropsMixin.PrefetchConsumptionProperty( avail_matching_criteria=[mediatailor.CfnPrefetchSchedulePropsMixin.AvailMatchingCriteriaProperty( dynamic_variable="dynamicVariable", operator="operator" )], end_time="endTime", start_time="startTime" ), name="name", playback_configuration_name="playbackConfigurationName", recurring_prefetch_configuration=mediatailor.CfnPrefetchSchedulePropsMixin.RecurringPrefetchConfigurationProperty( end_time="endTime", recurring_consumption=mediatailor.CfnPrefetchSchedulePropsMixin.RecurringConsumptionProperty( avail_matching_criteria=[mediatailor.CfnPrefetchSchedulePropsMixin.AvailMatchingCriteriaProperty( dynamic_variable="dynamicVariable", operator="operator" )], retrieved_ad_expiration_seconds=123 ), recurring_retrieval=mediatailor.CfnPrefetchSchedulePropsMixin.RecurringRetrievalProperty( delay_after_avail_end_seconds=123, dynamic_variables={ "dynamic_variables_key": "dynamicVariables" }, traffic_shaping_retrieval_window=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingRetrievalWindowProperty( retrieval_window_duration_seconds=123 ), traffic_shaping_tps_configuration=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingTpsConfigurationProperty( peak_concurrent_users=123, peak_tps=123 ), traffic_shaping_type="trafficShapingType" ), start_time="startTime" ), retrieval=mediatailor.CfnPrefetchSchedulePropsMixin.PrefetchRetrievalProperty( dynamic_variables={ "dynamic_variables_key": "dynamicVariables" }, end_time="endTime", start_time="startTime", traffic_shaping_retrieval_window=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingRetrievalWindowProperty( retrieval_window_duration_seconds=123 ), traffic_shaping_tps_configuration=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingTpsConfigurationProperty( peak_concurrent_users=123, peak_tps=123 ), traffic_shaping_type="trafficShapingType" ), schedule_type="scheduleType", stream_id="streamId", tags=[cdk.CfnTag( key="key", value="value" )] ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::MediaTailor::PrefetchSchedule.- Parameters:
props (
Union[CfnPrefetchScheduleMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['consumption', 'name', 'playbackConfigurationName', 'recurringPrefetchConfiguration', 'retrieval', 'scheduleType', 'streamId', 'tags']
Static Methods
- classmethod is_mixin(x)
Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.
AvailMatchingCriteriaProperty
- class CfnPrefetchSchedulePropsMixin.AvailMatchingCriteriaProperty(*, dynamic_variable=None, operator=None)
Bases:
object- Parameters:
dynamic_variable (
Optional[str]) – The dynamic variable(s) that MediaTailor should use as avail matching criteria.operator (
Optional[str]) – For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor avail_matching_criteria_property = mediatailor.CfnPrefetchSchedulePropsMixin.AvailMatchingCriteriaProperty( dynamic_variable="dynamicVariable", operator="operator" )
Attributes
- dynamic_variable
The dynamic variable(s) that MediaTailor should use as avail matching criteria.
- operator
For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
PrefetchConsumptionProperty
- class CfnPrefetchSchedulePropsMixin.PrefetchConsumptionProperty(*, avail_matching_criteria=None, end_time=None, start_time=None)
Bases:
object- Parameters:
avail_matching_criteria (
Union[IResolvable,Sequence[Union[IResolvable,AvailMatchingCriteriaProperty,Dict[str,Any]]],None]) – If you only want MediaTailor to insert prefetched ads into avails that match specific dynamic variables, set the avail matching criteria.end_time (
Optional[str]) – The time when MediaTailor no longer considers the prefetched ads for use in an ad break, as an ISO 8601 date-time.start_time (
Optional[str]) – The time when prefetched ads are considered for use in an ad break, as an ISO 8601 date-time.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor prefetch_consumption_property = mediatailor.CfnPrefetchSchedulePropsMixin.PrefetchConsumptionProperty( avail_matching_criteria=[mediatailor.CfnPrefetchSchedulePropsMixin.AvailMatchingCriteriaProperty( dynamic_variable="dynamicVariable", operator="operator" )], end_time="endTime", start_time="startTime" )
Attributes
- avail_matching_criteria
If you only want MediaTailor to insert prefetched ads into avails that match specific dynamic variables, set the avail matching criteria.
- end_time
The time when MediaTailor no longer considers the prefetched ads for use in an ad break, as an ISO 8601 date-time.
- start_time
The time when prefetched ads are considered for use in an ad break, as an ISO 8601 date-time.
PrefetchRetrievalProperty
- class CfnPrefetchSchedulePropsMixin.PrefetchRetrievalProperty(*, dynamic_variables=None, end_time=None, start_time=None, traffic_shaping_retrieval_window=None, traffic_shaping_tps_configuration=None, traffic_shaping_type=None)
Bases:
object- Parameters:
dynamic_variables (
Union[IResolvable,Mapping[str,str],None]) – The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).end_time (
Optional[str]) – The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time.start_time (
Optional[str]) – The time when prefetch retrievals can start for this break, as an ISO 8601 date-time.traffic_shaping_retrieval_window (
Union[IResolvable,TrafficShapingRetrievalWindowProperty,Dict[str,Any],None])traffic_shaping_tps_configuration (
Union[IResolvable,TrafficShapingTpsConfigurationProperty,Dict[str,Any],None])traffic_shaping_type (
Optional[str]) – Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor prefetch_retrieval_property = mediatailor.CfnPrefetchSchedulePropsMixin.PrefetchRetrievalProperty( dynamic_variables={ "dynamic_variables_key": "dynamicVariables" }, end_time="endTime", start_time="startTime", traffic_shaping_retrieval_window=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingRetrievalWindowProperty( retrieval_window_duration_seconds=123 ), traffic_shaping_tps_configuration=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingTpsConfigurationProperty( peak_concurrent_users=123, peak_tps=123 ), traffic_shaping_type="trafficShapingType" )
Attributes
- dynamic_variables
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
- end_time
The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time.
- start_time
The time when prefetch retrievals can start for this break, as an ISO 8601 date-time.
- traffic_shaping_retrieval_window
-
- Type:
see
- traffic_shaping_tps_configuration
-
- Type:
see
- traffic_shaping_type
Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.
RecurringConsumptionProperty
- class CfnPrefetchSchedulePropsMixin.RecurringConsumptionProperty(*, avail_matching_criteria=None, retrieved_ad_expiration_seconds=None)
Bases:
object- Parameters:
avail_matching_criteria (
Union[IResolvable,Sequence[Union[IResolvable,AvailMatchingCriteriaProperty,Dict[str,Any]]],None]) – The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.retrieved_ad_expiration_seconds (
Union[int,float,None]) – The number of seconds that an ad is available for insertion after it was prefetched.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor recurring_consumption_property = mediatailor.CfnPrefetchSchedulePropsMixin.RecurringConsumptionProperty( avail_matching_criteria=[mediatailor.CfnPrefetchSchedulePropsMixin.AvailMatchingCriteriaProperty( dynamic_variable="dynamicVariable", operator="operator" )], retrieved_ad_expiration_seconds=123 )
Attributes
- avail_matching_criteria
The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.
- retrieved_ad_expiration_seconds
The number of seconds that an ad is available for insertion after it was prefetched.
RecurringPrefetchConfigurationProperty
- class CfnPrefetchSchedulePropsMixin.RecurringPrefetchConfigurationProperty(*, end_time=None, recurring_consumption=None, recurring_retrieval=None, start_time=None)
Bases:
object- Parameters:
end_time (
Optional[str]) – The end time for the window that MediaTailor prefetches and inserts ads in a live event, as an ISO 8601 date-time.recurring_consumption (
Union[IResolvable,RecurringConsumptionProperty,Dict[str,Any],None])recurring_retrieval (
Union[IResolvable,RecurringRetrievalProperty,Dict[str,Any],None])start_time (
Optional[str]) – The start time for the window that MediaTailor prefetches and inserts ads in a live event, as an ISO 8601 date-time.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor recurring_prefetch_configuration_property = mediatailor.CfnPrefetchSchedulePropsMixin.RecurringPrefetchConfigurationProperty( end_time="endTime", recurring_consumption=mediatailor.CfnPrefetchSchedulePropsMixin.RecurringConsumptionProperty( avail_matching_criteria=[mediatailor.CfnPrefetchSchedulePropsMixin.AvailMatchingCriteriaProperty( dynamic_variable="dynamicVariable", operator="operator" )], retrieved_ad_expiration_seconds=123 ), recurring_retrieval=mediatailor.CfnPrefetchSchedulePropsMixin.RecurringRetrievalProperty( delay_after_avail_end_seconds=123, dynamic_variables={ "dynamic_variables_key": "dynamicVariables" }, traffic_shaping_retrieval_window=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingRetrievalWindowProperty( retrieval_window_duration_seconds=123 ), traffic_shaping_tps_configuration=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingTpsConfigurationProperty( peak_concurrent_users=123, peak_tps=123 ), traffic_shaping_type="trafficShapingType" ), start_time="startTime" )
Attributes
- end_time
The end time for the window that MediaTailor prefetches and inserts ads in a live event, as an ISO 8601 date-time.
- recurring_consumption
-
- Type:
see
- recurring_retrieval
-
- Type:
see
- start_time
The start time for the window that MediaTailor prefetches and inserts ads in a live event, as an ISO 8601 date-time.
RecurringRetrievalProperty
- class CfnPrefetchSchedulePropsMixin.RecurringRetrievalProperty(*, delay_after_avail_end_seconds=None, dynamic_variables=None, traffic_shaping_retrieval_window=None, traffic_shaping_tps_configuration=None, traffic_shaping_type=None)
Bases:
object- Parameters:
delay_after_avail_end_seconds (
Union[int,float,None]) – The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail.dynamic_variables (
Union[IResolvable,Mapping[str,str],None]) – The dynamic variables to use for substitution during prefetch requests to the ADS.traffic_shaping_retrieval_window (
Union[IResolvable,TrafficShapingRetrievalWindowProperty,Dict[str,Any],None])traffic_shaping_tps_configuration (
Union[IResolvable,TrafficShapingTpsConfigurationProperty,Dict[str,Any],None])traffic_shaping_type (
Optional[str]) – Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor recurring_retrieval_property = mediatailor.CfnPrefetchSchedulePropsMixin.RecurringRetrievalProperty( delay_after_avail_end_seconds=123, dynamic_variables={ "dynamic_variables_key": "dynamicVariables" }, traffic_shaping_retrieval_window=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingRetrievalWindowProperty( retrieval_window_duration_seconds=123 ), traffic_shaping_tps_configuration=mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingTpsConfigurationProperty( peak_concurrent_users=123, peak_tps=123 ), traffic_shaping_type="trafficShapingType" )
Attributes
- delay_after_avail_end_seconds
The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail.
- dynamic_variables
The dynamic variables to use for substitution during prefetch requests to the ADS.
- traffic_shaping_retrieval_window
-
- Type:
see
- traffic_shaping_tps_configuration
-
- Type:
see
- traffic_shaping_type
Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.
TrafficShapingRetrievalWindowProperty
- class CfnPrefetchSchedulePropsMixin.TrafficShapingRetrievalWindowProperty(*, retrieval_window_duration_seconds=None)
Bases:
object- Parameters:
retrieval_window_duration_seconds (
Union[int,float,None]) – The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor traffic_shaping_retrieval_window_property = mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingRetrievalWindowProperty( retrieval_window_duration_seconds=123 )
Attributes
- retrieval_window_duration_seconds
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
TrafficShapingTpsConfigurationProperty
- class CfnPrefetchSchedulePropsMixin.TrafficShapingTpsConfigurationProperty(*, peak_concurrent_users=None, peak_tps=None)
Bases:
object- Parameters:
peak_concurrent_users (
Union[int,float,None]) – The expected peak number of concurrent viewers for your content.peak_tps (
Union[int,float,None]) – The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor traffic_shaping_tps_configuration_property = mediatailor.CfnPrefetchSchedulePropsMixin.TrafficShapingTpsConfigurationProperty( peak_concurrent_users=123, peak_tps=123 )
Attributes
- peak_concurrent_users
The expected peak number of concurrent viewers for your content.
- peak_tps
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle.