CfnProgramProps

class aws_cdk.aws_mediatailor.CfnProgramProps(*, 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: object

Properties for defining a CfnProgram.

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

See:

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

cfn_program_props = mediatailor.CfnProgramProps(
    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"
)

Attributes

ad_breaks

The ad break configuration settings.

See:

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

audience_media

The list of AudienceMedia defined in program.

See:

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

channel_name

The name of the channel for this Program.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-channelname

live_source_name

The name of the LiveSource for this Program.

See:

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

program_name

The name of the Program.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-programname

schedule_configuration

Schedule configuration parameters.

See:

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

source_location_name

The name of the source location.

See:

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

vod_source_name

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

See:

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