CfnPrefetchSchedule

class aws_cdk.aws_mediatailor.CfnPrefetchSchedule(scope, id, *, name, playback_configuration_name, consumption=None, recurring_prefetch_configuration=None, retrieval=None, schedule_type=None, stream_id=None, tags=None)

Bases: CfnResource

Definition of AWS::MediaTailor::PrefetchSchedule Resource Type.

See:

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

CloudformationResource:

AWS::MediaTailor::PrefetchSchedule

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 = mediatailor.CfnPrefetchSchedule(self, "MyCfnPrefetchSchedule",
    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"
    )]
)

Create a new AWS::MediaTailor::PrefetchSchedule.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:
Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

  • The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)
Parameters:

cdk_property_name (str)

Return type:

Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:

List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Deprecated:

Use removeResourceDependency instead

Stability:

deprecated

Return type:

None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::MediaTailor::PrefetchSchedule'
attr_arn

The Amazon Resource Name (ARN) of the prefetch schedule.

CloudformationAttribute:

Arn

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

consumption
creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

env
logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name to assign to the prefetch schedule.

node

The tree node.

playback_configuration_name

The name of the playback configuration.

prefetch_schedule_ref

A reference to a PrefetchSchedule resource.

recurring_prefetch_configuration
ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

retrieval
schedule_type

The frequency that MediaTailor creates prefetch schedules.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

stream_id

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

tags

The tags assigned to the prefetch schedule.

Static Methods

classmethod arn_for_prefetch_schedule(resource)
Parameters:

resource (IPrefetchScheduleRef)

Return type:

str

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_prefetch_schedule(x)

Checks whether the given object is a CfnPrefetchSchedule.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AvailMatchingCriteriaProperty

class CfnPrefetchSchedule.AvailMatchingCriteriaProperty(*, dynamic_variable, operator)

Bases: object

Parameters:

  • dynamic_variable (str) – The dynamic variable(s) that MediaTailor should use as avail matching criteria.

  • operator (str) – For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

See:

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

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 import aws_mediatailor as mediatailor

avail_matching_criteria_property = mediatailor.CfnPrefetchSchedule.AvailMatchingCriteriaProperty(
    dynamic_variable="dynamicVariable",
    operator="operator"
)

Attributes

dynamic_variable

The dynamic variable(s) that MediaTailor should use as avail matching criteria.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-availmatchingcriteria.html#cfn-mediatailor-prefetchschedule-availmatchingcriteria-dynamicvariable

operator

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-availmatchingcriteria.html#cfn-mediatailor-prefetchschedule-availmatchingcriteria-operator

PrefetchConsumptionProperty

class CfnPrefetchSchedule.PrefetchConsumptionProperty(*, end_time, avail_matching_criteria=None, start_time=None)

Bases: object

Parameters:

  • end_time (str) – The time when MediaTailor no longer considers the prefetched ads for use in an ad break, as an ISO 8601 date-time.

  • 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.

  • start_time (Optional[str]) – The time when prefetched ads are considered for use in an ad break, as an ISO 8601 date-time.

See:

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

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 import aws_mediatailor as mediatailor

prefetch_consumption_property = 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"
)

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchconsumption.html#cfn-mediatailor-prefetchschedule-prefetchconsumption-availmatchingcriteria

end_time

The time when MediaTailor no longer considers the prefetched ads for use in an ad break, as an ISO 8601 date-time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchconsumption.html#cfn-mediatailor-prefetchschedule-prefetchconsumption-endtime

start_time

The time when prefetched ads are considered for use in an ad break, as an ISO 8601 date-time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchconsumption.html#cfn-mediatailor-prefetchschedule-prefetchconsumption-starttime

PrefetchRetrievalProperty

class CfnPrefetchSchedule.PrefetchRetrievalProperty(*, end_time, dynamic_variables=None, start_time=None, traffic_shaping_retrieval_window=None, traffic_shaping_tps_configuration=None, traffic_shaping_type=None)

Bases: object

Parameters:

  • end_time (str) – The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time.

  • dynamic_variables (Union[IResolvable, Mapping[str, str], None]) – The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

  • 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:

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

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 import aws_mediatailor as mediatailor

prefetch_retrieval_property = 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"
)

Attributes

dynamic_variables

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

See:

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

end_time

The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time.

See:

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

start_time

The time when prefetch retrievals can start for this break, as an ISO 8601 date-time.

See:

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

traffic_shaping_retrieval_window

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

Type:

see

traffic_shaping_tps_configuration

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

Type:

see

traffic_shaping_type

Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.

See:

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

RecurringConsumptionProperty

class CfnPrefetchSchedule.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:

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

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 import aws_mediatailor as mediatailor

recurring_consumption_property = mediatailor.CfnPrefetchSchedule.RecurringConsumptionProperty(
    avail_matching_criteria=[mediatailor.CfnPrefetchSchedule.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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringconsumption.html#cfn-mediatailor-prefetchschedule-recurringconsumption-availmatchingcriteria

retrieved_ad_expiration_seconds

The number of seconds that an ad is available for insertion after it was prefetched.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringconsumption.html#cfn-mediatailor-prefetchschedule-recurringconsumption-retrievedadexpirationseconds

RecurringPrefetchConfigurationProperty

class CfnPrefetchSchedule.RecurringPrefetchConfigurationProperty(*, end_time, recurring_consumption, recurring_retrieval, start_time=None)

Bases: object

Parameters:

  • end_time (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]])

  • recurring_retrieval (Union[IResolvable, RecurringRetrievalProperty, Dict[str, Any]])

  • 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:

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

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 import aws_mediatailor as mediatailor

recurring_prefetch_configuration_property = 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"
)

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.

See:

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

recurring_consumption

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

Type:

see

recurring_retrieval

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

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.

See:

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

RecurringRetrievalProperty

class CfnPrefetchSchedule.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:

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

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 import aws_mediatailor as mediatailor

recurring_retrieval_property = 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"
)

Attributes

delay_after_avail_end_seconds

The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringretrieval.html#cfn-mediatailor-prefetchschedule-recurringretrieval-delayafteravailendseconds

dynamic_variables

The dynamic variables to use for substitution during prefetch requests to the ADS.

See:

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

traffic_shaping_retrieval_window

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

Type:

see

traffic_shaping_tps_configuration

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

Type:

see

traffic_shaping_type

Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringretrieval.html#cfn-mediatailor-prefetchschedule-recurringretrieval-trafficshapingtype

TrafficShapingRetrievalWindowProperty

class CfnPrefetchSchedule.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:

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

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 import aws_mediatailor as mediatailor

traffic_shaping_retrieval_window_property = mediatailor.CfnPrefetchSchedule.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.

See:

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

TrafficShapingTpsConfigurationProperty

class CfnPrefetchSchedule.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:

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

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 import aws_mediatailor as mediatailor

traffic_shaping_tps_configuration_property = mediatailor.CfnPrefetchSchedule.TrafficShapingTpsConfigurationProperty(
    peak_concurrent_users=123,
    peak_tps=123
)

Attributes

peak_concurrent_users

The expected peak number of concurrent viewers for your content.

See:

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

peak_tps

The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle.

See:

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