CfnProgram

class aws_cdk.aws_mediatailor.CfnProgram(scope, id, *, channel_name, program_name, source_location_name, ad_breaks=None, audience_media=None, live_source_name=None, schedule_configuration=None, vod_source_name=None)

Bases: CfnResource

Resource schema for AWS::MediaTailor::Program.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html
CloudformationResource:: AWS::MediaTailor::Program
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

cfn_program = mediatailor.CfnProgram(self, "MyCfnProgram",
    channel_name="channelName",
    program_name="programName",
    source_location_name="sourceLocationName",

    # the properties below are optional
    ad_breaks=[mediatailor.CfnProgram.AdBreakProperty(
        offset_millis=123,

        # the properties below are optional
        ad_break_metadata=[mediatailor.CfnProgram.KeyValuePairProperty(
            key="key",
            value="value"
        )],
        message_type="messageType",
        slate=mediatailor.CfnProgram.SlateSourceProperty(
            source_location_name="sourceLocationName",
            vod_source_name="vodSourceName"
        ),
        splice_insert_message=mediatailor.CfnProgram.SpliceInsertMessageProperty(
            avail_num=123,
            avails_expected=123,
            splice_event_id=123,
            unique_program_id=123
        ),
        time_signal_message=mediatailor.CfnProgram.TimeSignalMessageProperty(
            segmentation_descriptors=[mediatailor.CfnProgram.SegmentationDescriptorProperty(
                segmentation_event_id=123,
                segmentation_type_id=123,
                segmentation_upid="segmentationUpid",
                segmentation_upid_type=123,
                segment_num=123,
                segments_expected=123,
                sub_segment_num=123,
                sub_segments_expected=123
            )]
        )
    )],
    audience_media=[mediatailor.CfnProgram.AudienceMediaProperty(
        alternate_media=[mediatailor.CfnProgram.AlternateMediaProperty(
            ad_breaks=[mediatailor.CfnProgram.AdBreakProperty(
                offset_millis=123,

                # the properties below are optional
                ad_break_metadata=[mediatailor.CfnProgram.KeyValuePairProperty(
                    key="key",
                    value="value"
                )],
                message_type="messageType",
                slate=mediatailor.CfnProgram.SlateSourceProperty(
                    source_location_name="sourceLocationName",
                    vod_source_name="vodSourceName"
                ),
                splice_insert_message=mediatailor.CfnProgram.SpliceInsertMessageProperty(
                    avail_num=123,
                    avails_expected=123,
                    splice_event_id=123,
                    unique_program_id=123
                ),
                time_signal_message=mediatailor.CfnProgram.TimeSignalMessageProperty(
                    segmentation_descriptors=[mediatailor.CfnProgram.SegmentationDescriptorProperty(
                        segmentation_event_id=123,
                        segmentation_type_id=123,
                        segmentation_upid="segmentationUpid",
                        segmentation_upid_type=123,
                        segment_num=123,
                        segments_expected=123,
                        sub_segment_num=123,
                        sub_segments_expected=123
                    )]
                )
            )],
            clip_range=mediatailor.CfnProgram.ClipRangeProperty(
                end_offset_millis=123,
                start_offset_millis=123
            ),
            duration_millis=123,
            live_source_name="liveSourceName",
            scheduled_start_time_millis=123,
            source_location_name="sourceLocationName",
            vod_source_name="vodSourceName"
        )],
        audience="audience"
    )],
    live_source_name="liveSourceName",
    schedule_configuration=mediatailor.CfnProgram.ScheduleConfigurationProperty(
        transition=mediatailor.CfnProgram.TransitionProperty(
            relative_position="relativePosition",
            type="type",

            # the properties below are optional
            duration_millis=123,
            relative_program="relativeProgram",
            scheduled_start_time_millis=123
        ),

        # the properties below are optional
        clip_range=mediatailor.CfnProgram.ClipRangeProperty(
            end_offset_millis=123,
            start_offset_millis=123
        )
    ),
    vod_source_name="vodSourceName"
)

Create a new AWS::MediaTailor::Program.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
channel_name (str) – The name of the channel for this Program.
program_name (str) – The name of the Program.
source_location_name (str) – The name of the source location.
ad_breaks (Union[IResolvable, Sequence[Union[IResolvable, AdBreakProperty, Dict[str, Any]]], None]) – The ad break configuration settings.
audience_media (Union[IResolvable, Sequence[Union[IResolvable, AudienceMediaProperty, Dict[str, Any]]], None]) – The list of AudienceMedia defined in program.
live_source_name (Optional[str]) – The name of the LiveSource for this Program.
schedule_configuration (Union[IResolvable, ScheduleConfigurationProperty, Dict[str, Any], None]) – Schedule configuration parameters.
vod_source_name (Optional[str]) – The name that’s used to refer to a VOD source.

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:

target (CfnResource)
reason (Optional[str])

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:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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::Program'

ad_breaks: The ad break configuration settings.

attr_arn

The ARN of the program.

CloudformationAttribute:: Arn

attr_clip_range

Clip range configuration for the VOD source associated with the program.

CloudformationAttribute:: ClipRange

attr_creation_time

The timestamp of when the program was created.

CloudformationAttribute:: CreationTime

attr_duration_millis

The duration of the live program in milliseconds.

CloudformationAttribute:: DurationMillis

attr_scheduled_start_time

The date and time that the program is scheduled to start.

CloudformationAttribute:: ScheduledStartTime

audience_media: The list of AudienceMedia defined in program.

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

cfn_resource_type: AWS resource type.

channel_name: The name of the channel for this Program.

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

live_source_name: The name of the LiveSource for this Program.

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.

node: The tree node.

program_name: The name of the Program.

program_ref: A reference to a Program resource.

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 }).

schedule_configuration: Schedule configuration parameters.

source_location_name: The name of the source location.

stack

The stack in which this element is defined.

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

vod_source_name: The name that’s used to refer to a VOD source.

Static Methods

classmethod arn_for_program(resource)

Parameters:: resource (IProgramRef)
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_program(x)

Checks whether the given object is a CfnProgram.

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.

AdBreakProperty

class CfnProgram.AdBreakProperty(*, offset_millis, ad_break_metadata=None, message_type=None, slate=None, splice_insert_message=None, time_signal_message=None)

Bases: object

Ad break configuration parameters.

Parameters:

offset_millis (Union[int, float]) – How long (in milliseconds) after the beginning of the program that an ad starts.
ad_break_metadata (Union[IResolvable, Sequence[Union[IResolvable, KeyValuePairProperty, Dict[str, Any]]], None]) – Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET tag for SCTE35_ENHANCED output.
message_type (Optional[str]) – The SCTE-35 ad insertion type.
slate (Union[IResolvable, SlateSourceProperty, Dict[str, Any], None]) – Slate VOD source configuration.
splice_insert_message (Union[IResolvable, SpliceInsertMessageProperty, Dict[str, Any], None]) – Splice insert message configuration.
time_signal_message (Union[IResolvable, TimeSignalMessageProperty, Dict[str, Any], None]) – The SCTE-35 time_signal message configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.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

ad_break_property = mediatailor.CfnProgram.AdBreakProperty(
    offset_millis=123,

    # the properties below are optional
    ad_break_metadata=[mediatailor.CfnProgram.KeyValuePairProperty(
        key="key",
        value="value"
    )],
    message_type="messageType",
    slate=mediatailor.CfnProgram.SlateSourceProperty(
        source_location_name="sourceLocationName",
        vod_source_name="vodSourceName"
    ),
    splice_insert_message=mediatailor.CfnProgram.SpliceInsertMessageProperty(
        avail_num=123,
        avails_expected=123,
        splice_event_id=123,
        unique_program_id=123
    ),
    time_signal_message=mediatailor.CfnProgram.TimeSignalMessageProperty(
        segmentation_descriptors=[mediatailor.CfnProgram.SegmentationDescriptorProperty(
            segmentation_event_id=123,
            segmentation_type_id=123,
            segmentation_upid="segmentationUpid",
            segmentation_upid_type=123,
            segment_num=123,
            segments_expected=123,
            sub_segment_num=123,
            sub_segments_expected=123
        )]
    )
)

Attributes

ad_break_metadata

Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET tag for SCTE35_ENHANCED output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-adbreakmetadata

message_type

The SCTE-35 ad insertion type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-messagetype

offset_millis

How long (in milliseconds) after the beginning of the program that an ad starts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-offsetmillis

slate

Slate VOD source configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-slate

splice_insert_message

Splice insert message configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-spliceinsertmessage

time_signal_message

The SCTE-35 time_signal message configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-timesignalmessage

AlternateMediaProperty

class CfnProgram.AlternateMediaProperty(*, ad_breaks=None, clip_range=None, duration_millis=None, live_source_name=None, scheduled_start_time_millis=None, source_location_name=None, vod_source_name=None)

Bases: object

A playlist of media to be played instead of the default media on a particular program.

Parameters:

ad_breaks (Union[IResolvable, Sequence[Union[IResolvable, AdBreakProperty, Dict[str, Any]]], None]) – Ad break configuration parameters defined in AlternateMedia.
clip_range (Union[IResolvable, ClipRangeProperty, Dict[str, Any], None]) – Clip range configuration for the VOD source associated with the program.
duration_millis (Union[int, float, None]) – The duration of the alternateMedia in milliseconds.
live_source_name (Optional[str]) – The name of the live source for alternateMedia.
scheduled_start_time_millis (Union[int, float, None]) – The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
source_location_name (Optional[str]) – The name of the source location for alternateMedia.
vod_source_name (Optional[str]) – The name of the VOD source for alternateMedia.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.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

alternate_media_property = mediatailor.CfnProgram.AlternateMediaProperty(
    ad_breaks=[mediatailor.CfnProgram.AdBreakProperty(
        offset_millis=123,

        # the properties below are optional
        ad_break_metadata=[mediatailor.CfnProgram.KeyValuePairProperty(
            key="key",
            value="value"
        )],
        message_type="messageType",
        slate=mediatailor.CfnProgram.SlateSourceProperty(
            source_location_name="sourceLocationName",
            vod_source_name="vodSourceName"
        ),
        splice_insert_message=mediatailor.CfnProgram.SpliceInsertMessageProperty(
            avail_num=123,
            avails_expected=123,
            splice_event_id=123,
            unique_program_id=123
        ),
        time_signal_message=mediatailor.CfnProgram.TimeSignalMessageProperty(
            segmentation_descriptors=[mediatailor.CfnProgram.SegmentationDescriptorProperty(
                segmentation_event_id=123,
                segmentation_type_id=123,
                segmentation_upid="segmentationUpid",
                segmentation_upid_type=123,
                segment_num=123,
                segments_expected=123,
                sub_segment_num=123,
                sub_segments_expected=123
            )]
        )
    )],
    clip_range=mediatailor.CfnProgram.ClipRangeProperty(
        end_offset_millis=123,
        start_offset_millis=123
    ),
    duration_millis=123,
    live_source_name="liveSourceName",
    scheduled_start_time_millis=123,
    source_location_name="sourceLocationName",
    vod_source_name="vodSourceName"
)

Attributes

ad_breaks

Ad break configuration parameters defined in AlternateMedia.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-adbreaks

clip_range

Clip range configuration for the VOD source associated with the program.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-cliprange

duration_millis

The duration of the alternateMedia in milliseconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-durationmillis

live_source_name

The name of the live source for alternateMedia.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-livesourcename

scheduled_start_time_millis

The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-scheduledstarttimemillis

source_location_name

The name of the source location for alternateMedia.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-sourcelocationname

vod_source_name

The name of the VOD source for alternateMedia.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-vodsourcename

AudienceMediaProperty

class CfnProgram.AudienceMediaProperty(*, alternate_media=None, audience=None)

Bases: object

An AudienceMedia object contains an Audience and a list of AlternateMedia.

Parameters:

alternate_media (Union[IResolvable, Sequence[Union[IResolvable, AlternateMediaProperty, Dict[str, Any]]], None]) – The list of AlternateMedia defined in AudienceMedia.
audience (Optional[str]) – The Audience defined in AudienceMedia.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-audiencemedia.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

audience_media_property = mediatailor.CfnProgram.AudienceMediaProperty(
    alternate_media=[mediatailor.CfnProgram.AlternateMediaProperty(
        ad_breaks=[mediatailor.CfnProgram.AdBreakProperty(
            offset_millis=123,

            # the properties below are optional
            ad_break_metadata=[mediatailor.CfnProgram.KeyValuePairProperty(
                key="key",
                value="value"
            )],
            message_type="messageType",
            slate=mediatailor.CfnProgram.SlateSourceProperty(
                source_location_name="sourceLocationName",
                vod_source_name="vodSourceName"
            ),
            splice_insert_message=mediatailor.CfnProgram.SpliceInsertMessageProperty(
                avail_num=123,
                avails_expected=123,
                splice_event_id=123,
                unique_program_id=123
            ),
            time_signal_message=mediatailor.CfnProgram.TimeSignalMessageProperty(
                segmentation_descriptors=[mediatailor.CfnProgram.SegmentationDescriptorProperty(
                    segmentation_event_id=123,
                    segmentation_type_id=123,
                    segmentation_upid="segmentationUpid",
                    segmentation_upid_type=123,
                    segment_num=123,
                    segments_expected=123,
                    sub_segment_num=123,
                    sub_segments_expected=123
                )]
            )
        )],
        clip_range=mediatailor.CfnProgram.ClipRangeProperty(
            end_offset_millis=123,
            start_offset_millis=123
        ),
        duration_millis=123,
        live_source_name="liveSourceName",
        scheduled_start_time_millis=123,
        source_location_name="sourceLocationName",
        vod_source_name="vodSourceName"
    )],
    audience="audience"
)

Attributes

alternate_media

The list of AlternateMedia defined in AudienceMedia.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-audiencemedia.html#cfn-mediatailor-program-audiencemedia-alternatemedia

audience

The Audience defined in AudienceMedia.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-audiencemedia.html#cfn-mediatailor-program-audiencemedia-audience

ClipRangeProperty

class CfnProgram.ClipRangeProperty(*, end_offset_millis=None, start_offset_millis=None)

Bases: object

Clip range configuration for the VOD source associated with the program.

Parameters:

end_offset_millis (Union[int, float, None]) – The end offset of the clip range, in milliseconds.
start_offset_millis (Union[int, float, None]) – The start offset of the clip range, in milliseconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-cliprange.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

clip_range_property = mediatailor.CfnProgram.ClipRangeProperty(
    end_offset_millis=123,
    start_offset_millis=123
)

Attributes

end_offset_millis

The end offset of the clip range, in milliseconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-cliprange.html#cfn-mediatailor-program-cliprange-endoffsetmillis

start_offset_millis

The start offset of the clip range, in milliseconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-cliprange.html#cfn-mediatailor-program-cliprange-startoffsetmillis

KeyValuePairProperty

class CfnProgram.KeyValuePairProperty(*, key, value)

Bases: object

For SCTE35_ENHANCED output, defines a key and corresponding value.

Parameters:

key (str) – The key.
value (str) – The value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-keyvaluepair.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

key_value_pair_property = mediatailor.CfnProgram.KeyValuePairProperty(
    key="key",
    value="value"
)

Attributes

key

The key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-keyvaluepair.html#cfn-mediatailor-program-keyvaluepair-key

value

The value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-keyvaluepair.html#cfn-mediatailor-program-keyvaluepair-value

ScheduleConfigurationProperty

class CfnProgram.ScheduleConfigurationProperty(*, transition, clip_range=None)

Bases: object

Schedule configuration parameters.

Parameters:

transition (Union[IResolvable, TransitionProperty, Dict[str, Any]]) – Program transition configuration.
clip_range (Union[IResolvable, ClipRangeProperty, Dict[str, Any], None]) – Clip range configuration for the VOD source associated with the program.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-scheduleconfiguration.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

schedule_configuration_property = mediatailor.CfnProgram.ScheduleConfigurationProperty(
    transition=mediatailor.CfnProgram.TransitionProperty(
        relative_position="relativePosition",
        type="type",

        # the properties below are optional
        duration_millis=123,
        relative_program="relativeProgram",
        scheduled_start_time_millis=123
    ),

    # the properties below are optional
    clip_range=mediatailor.CfnProgram.ClipRangeProperty(
        end_offset_millis=123,
        start_offset_millis=123
    )
)

Attributes

clip_range

Clip range configuration for the VOD source associated with the program.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-scheduleconfiguration.html#cfn-mediatailor-program-scheduleconfiguration-cliprange

transition

Program transition configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-scheduleconfiguration.html#cfn-mediatailor-program-scheduleconfiguration-transition

SegmentationDescriptorProperty

class CfnProgram.SegmentationDescriptorProperty(*, segmentation_event_id=None, segmentation_type_id=None, segmentation_upid=None, segmentation_upid_type=None, segment_num=None, segments_expected=None, sub_segment_num=None, sub_segments_expected=None)

Bases: object

The segmentation_descriptor message configuration.

Parameters:

segmentation_event_id (Union[int, float, None]) – The Event Identifier to assign.
segmentation_type_id (Union[int, float, None]) – The Type Identifier to assign.
segmentation_upid (Optional[str]) – The Upid to assign.
segmentation_upid_type (Union[int, float, None]) – The Upid Type to assign.
segment_num (Union[int, float, None]) – The segment number to assign.
segments_expected (Union[int, float, None]) – The number of segments expected.
sub_segment_num (Union[int, float, None]) – The sub-segment number to assign.
sub_segments_expected (Union[int, float, None]) – The number of sub-segments expected.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.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

segmentation_descriptor_property = mediatailor.CfnProgram.SegmentationDescriptorProperty(
    segmentation_event_id=123,
    segmentation_type_id=123,
    segmentation_upid="segmentationUpid",
    segmentation_upid_type=123,
    segment_num=123,
    segments_expected=123,
    sub_segment_num=123,
    sub_segments_expected=123
)

Attributes

segment_num

The segment number to assign.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentnum

segmentation_event_id

The Event Identifier to assign.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentationeventid

segmentation_type_id

The Type Identifier to assign.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentationtypeid

segmentation_upid

The Upid to assign.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentationupid

segmentation_upid_type

The Upid Type to assign.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentationupidtype

segments_expected

The number of segments expected.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentsexpected

sub_segment_num

The sub-segment number to assign.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-subsegmentnum

sub_segments_expected

The number of sub-segments expected.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-subsegmentsexpected

SlateSourceProperty

class CfnProgram.SlateSourceProperty(*, source_location_name=None, vod_source_name=None)

Bases: object

Slate VOD source configuration.

Parameters:

source_location_name (Optional[str]) – The name of the source location where the slate VOD source is stored.
vod_source_name (Optional[str]) – The slate VOD source name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-slatesource.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

slate_source_property = mediatailor.CfnProgram.SlateSourceProperty(
    source_location_name="sourceLocationName",
    vod_source_name="vodSourceName"
)

Attributes

source_location_name

The name of the source location where the slate VOD source is stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-slatesource.html#cfn-mediatailor-program-slatesource-sourcelocationname

vod_source_name

The slate VOD source name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-slatesource.html#cfn-mediatailor-program-slatesource-vodsourcename

SpliceInsertMessageProperty

class CfnProgram.SpliceInsertMessageProperty(*, avail_num=None, avails_expected=None, splice_event_id=None, unique_program_id=None)

Bases: object

Splice insert message configuration.

Parameters:

avail_num (Union[int, float, None]) – This is written to splice_insert.avail_num.
avails_expected (Union[int, float, None]) – This is written to splice_insert.avails_expected.
splice_event_id (Union[int, float, None]) – This is written to splice_insert.splice_event_id.
unique_program_id (Union[int, float, None]) – This is written to splice_insert.unique_program_id.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.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

splice_insert_message_property = mediatailor.CfnProgram.SpliceInsertMessageProperty(
    avail_num=123,
    avails_expected=123,
    splice_event_id=123,
    unique_program_id=123
)

Attributes

avail_num

This is written to splice_insert.avail_num.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.html#cfn-mediatailor-program-spliceinsertmessage-availnum

avails_expected

This is written to splice_insert.avails_expected.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.html#cfn-mediatailor-program-spliceinsertmessage-availsexpected

splice_event_id

This is written to splice_insert.splice_event_id.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.html#cfn-mediatailor-program-spliceinsertmessage-spliceeventid

unique_program_id

This is written to splice_insert.unique_program_id.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.html#cfn-mediatailor-program-spliceinsertmessage-uniqueprogramid

TimeSignalMessageProperty

class CfnProgram.TimeSignalMessageProperty(*, segmentation_descriptors=None)

Bases: object

The SCTE-35 time_signal message configuration.

Parameters:: segmentation_descriptors (Union[IResolvable, Sequence[Union[IResolvable, SegmentationDescriptorProperty, Dict[str, Any]]], None]) – The configurations for the SCTE-35 segmentation_descriptor message(s).
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-timesignalmessage.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

time_signal_message_property = mediatailor.CfnProgram.TimeSignalMessageProperty(
    segmentation_descriptors=[mediatailor.CfnProgram.SegmentationDescriptorProperty(
        segmentation_event_id=123,
        segmentation_type_id=123,
        segmentation_upid="segmentationUpid",
        segmentation_upid_type=123,
        segment_num=123,
        segments_expected=123,
        sub_segment_num=123,
        sub_segments_expected=123
    )]
)

Attributes

segmentation_descriptors

The configurations for the SCTE-35 segmentation_descriptor message(s).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-timesignalmessage.html#cfn-mediatailor-program-timesignalmessage-segmentationdescriptors

TransitionProperty

class CfnProgram.TransitionProperty(*, relative_position, type, duration_millis=None, relative_program=None, scheduled_start_time_millis=None)

Bases: object

Program transition configuration.

Parameters:

relative_position (str) – The position where this program will be inserted relative to the RelativePosition.
type (str) – Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
duration_millis (Union[int, float, None]) – The duration of the live program in seconds.
relative_program (Optional[str]) – The name of the program that this program will be inserted next to.
scheduled_start_time_millis (Union[int, float, None]) – The date and time that the program is scheduled to start, in epoch milliseconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-transition.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

transition_property = mediatailor.CfnProgram.TransitionProperty(
    relative_position="relativePosition",
    type="type",

    # the properties below are optional
    duration_millis=123,
    relative_program="relativeProgram",
    scheduled_start_time_millis=123
)