CfnPrefetchScheduleProps

class aws_cdk.aws_mediatailor.CfnPrefetchScheduleProps(*, name, playback_configuration_name, consumption=None, recurring_prefetch_configuration=None, retrieval=None, schedule_type=None, stream_id=None, tags=None)

Bases: object

Properties for defining a CfnPrefetchSchedule.

Parameters:

name (str) – The name to assign to the prefetch schedule.
playback_configuration_name (str) – The name of the playback configuration.
consumption (Union[IResolvable, PrefetchConsumptionProperty, Dict[str, Any], None])
recurring_prefetch_configuration (Union[IResolvable, RecurringPrefetchConfigurationProperty, Dict[str, Any], None])
retrieval (Union[IResolvable, PrefetchRetrievalProperty, Dict[str, Any], None])
schedule_type (Optional[str]) – The frequency that MediaTailor creates prefetch schedules.
stream_id (Optional[str]) – An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags assigned to the prefetch schedule.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediatailor as mediatailor

cfn_prefetch_schedule_props = mediatailor.CfnPrefetchScheduleProps(
    name="name",
    playback_configuration_name="playbackConfigurationName",

    # the properties below are optional
    consumption=mediatailor.CfnPrefetchSchedule.PrefetchConsumptionProperty(
        end_time="endTime",

        # the properties below are optional
        avail_matching_criteria=[mediatailor.CfnPrefetchSchedule.AvailMatchingCriteriaProperty(
            dynamic_variable="dynamicVariable",
            operator="operator"
        )],
        start_time="startTime"
    ),
    recurring_prefetch_configuration=mediatailor.CfnPrefetchSchedule.RecurringPrefetchConfigurationProperty(
        end_time="endTime",
        recurring_consumption=mediatailor.CfnPrefetchSchedule.RecurringConsumptionProperty(
            avail_matching_criteria=[mediatailor.CfnPrefetchSchedule.AvailMatchingCriteriaProperty(
                dynamic_variable="dynamicVariable",
                operator="operator"
            )],
            retrieved_ad_expiration_seconds=123
        ),
        recurring_retrieval=mediatailor.CfnPrefetchSchedule.RecurringRetrievalProperty(
            delay_after_avail_end_seconds=123,
            dynamic_variables={
                "dynamic_variables_key": "dynamicVariables"
            },
            traffic_shaping_retrieval_window=mediatailor.CfnPrefetchSchedule.TrafficShapingRetrievalWindowProperty(
                retrieval_window_duration_seconds=123
            ),
            traffic_shaping_tps_configuration=mediatailor.CfnPrefetchSchedule.TrafficShapingTpsConfigurationProperty(
                peak_concurrent_users=123,
                peak_tps=123
            ),
            traffic_shaping_type="trafficShapingType"
        ),

        # the properties below are optional
        start_time="startTime"
    ),
    retrieval=mediatailor.CfnPrefetchSchedule.PrefetchRetrievalProperty(
        end_time="endTime",

        # the properties below are optional
        dynamic_variables={
            "dynamic_variables_key": "dynamicVariables"
        },
        start_time="startTime",
        traffic_shaping_retrieval_window=mediatailor.CfnPrefetchSchedule.TrafficShapingRetrievalWindowProperty(
            retrieval_window_duration_seconds=123
        ),
        traffic_shaping_tps_configuration=mediatailor.CfnPrefetchSchedule.TrafficShapingTpsConfigurationProperty(
            peak_concurrent_users=123,
            peak_tps=123
        ),
        traffic_shaping_type="trafficShapingType"
    ),
    schedule_type="scheduleType",
    stream_id="streamId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)