CfnProgramPropsMixin
- class aws_cdk.cfn_property_mixins.aws_mediatailor.CfnProgramPropsMixin(props, *, strategy=None)
Bases:
MixinResource schema for AWS::MediaTailor::Program.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html
- CloudformationResource:
AWS::MediaTailor::Program
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor import aws_cdk as cdk # merge_strategy: cdk.IMergeStrategy cfn_program_props_mixin = mediatailor.CfnProgramPropsMixin(mediatailor.CfnProgramMixinProps( ad_breaks=[mediatailor.CfnProgramPropsMixin.AdBreakProperty( ad_break_metadata=[mediatailor.CfnProgramPropsMixin.KeyValuePairProperty( key="key", value="value" )], message_type="messageType", offset_millis=123, slate=mediatailor.CfnProgramPropsMixin.SlateSourceProperty( source_location_name="sourceLocationName", vod_source_name="vodSourceName" ), splice_insert_message=mediatailor.CfnProgramPropsMixin.SpliceInsertMessageProperty( avail_num=123, avails_expected=123, splice_event_id=123, unique_program_id=123 ), time_signal_message=mediatailor.CfnProgramPropsMixin.TimeSignalMessageProperty( segmentation_descriptors=[mediatailor.CfnProgramPropsMixin.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.CfnProgramPropsMixin.AudienceMediaProperty( alternate_media=[mediatailor.CfnProgramPropsMixin.AlternateMediaProperty( ad_breaks=[mediatailor.CfnProgramPropsMixin.AdBreakProperty( ad_break_metadata=[mediatailor.CfnProgramPropsMixin.KeyValuePairProperty( key="key", value="value" )], message_type="messageType", offset_millis=123, slate=mediatailor.CfnProgramPropsMixin.SlateSourceProperty( source_location_name="sourceLocationName", vod_source_name="vodSourceName" ), splice_insert_message=mediatailor.CfnProgramPropsMixin.SpliceInsertMessageProperty( avail_num=123, avails_expected=123, splice_event_id=123, unique_program_id=123 ), time_signal_message=mediatailor.CfnProgramPropsMixin.TimeSignalMessageProperty( segmentation_descriptors=[mediatailor.CfnProgramPropsMixin.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.CfnProgramPropsMixin.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" )], channel_name="channelName", live_source_name="liveSourceName", program_name="programName", schedule_configuration=mediatailor.CfnProgramPropsMixin.ScheduleConfigurationProperty( clip_range=mediatailor.CfnProgramPropsMixin.ClipRangeProperty( end_offset_millis=123, start_offset_millis=123 ), transition=mediatailor.CfnProgramPropsMixin.TransitionProperty( duration_millis=123, relative_position="relativePosition", relative_program="relativeProgram", scheduled_start_time_millis=123, type="type" ) ), source_location_name="sourceLocationName", vod_source_name="vodSourceName" ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::MediaTailor::Program.- Parameters:
props (
Union[CfnProgramMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['adBreaks', 'audienceMedia', 'channelName', 'liveSourceName', 'programName', 'scheduleConfiguration', 'sourceLocationName', 'vodSourceName']
Static Methods
- classmethod is_mixin(x)
Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.
AdBreakProperty
- class CfnProgramPropsMixin.AdBreakProperty(*, ad_break_metadata=None, message_type=None, offset_millis=None, slate=None, splice_insert_message=None, time_signal_message=None)
Bases:
objectAd break configuration parameters.
- Parameters:
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.offset_millis (
Union[int,float,None]) – How long (in milliseconds) after the beginning of the program that an ad starts.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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor ad_break_property = mediatailor.CfnProgramPropsMixin.AdBreakProperty( ad_break_metadata=[mediatailor.CfnProgramPropsMixin.KeyValuePairProperty( key="key", value="value" )], message_type="messageType", offset_millis=123, slate=mediatailor.CfnProgramPropsMixin.SlateSourceProperty( source_location_name="sourceLocationName", vod_source_name="vodSourceName" ), splice_insert_message=mediatailor.CfnProgramPropsMixin.SpliceInsertMessageProperty( avail_num=123, avails_expected=123, splice_event_id=123, unique_program_id=123 ), time_signal_message=mediatailor.CfnProgramPropsMixin.TimeSignalMessageProperty( segmentation_descriptors=[mediatailor.CfnProgramPropsMixin.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.
- message_type
The SCTE-35 ad insertion type.
- offset_millis
How long (in milliseconds) after the beginning of the program that an ad starts.
- slate
Slate VOD source configuration.
- splice_insert_message
Splice insert message configuration.
- time_signal_message
The SCTE-35 time_signal message configuration.
AlternateMediaProperty
- class CfnProgramPropsMixin.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:
objectA 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor alternate_media_property = mediatailor.CfnProgramPropsMixin.AlternateMediaProperty( ad_breaks=[mediatailor.CfnProgramPropsMixin.AdBreakProperty( ad_break_metadata=[mediatailor.CfnProgramPropsMixin.KeyValuePairProperty( key="key", value="value" )], message_type="messageType", offset_millis=123, slate=mediatailor.CfnProgramPropsMixin.SlateSourceProperty( source_location_name="sourceLocationName", vod_source_name="vodSourceName" ), splice_insert_message=mediatailor.CfnProgramPropsMixin.SpliceInsertMessageProperty( avail_num=123, avails_expected=123, splice_event_id=123, unique_program_id=123 ), time_signal_message=mediatailor.CfnProgramPropsMixin.TimeSignalMessageProperty( segmentation_descriptors=[mediatailor.CfnProgramPropsMixin.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.CfnProgramPropsMixin.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.
- clip_range
Clip range configuration for the VOD source associated with the program.
- duration_millis
The duration of the alternateMedia in milliseconds.
- live_source_name
The name of the live source for alternateMedia.
- scheduled_start_time_millis
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
- source_location_name
The name of the source location for alternateMedia.
- vod_source_name
The name of the VOD source for alternateMedia.
AudienceMediaProperty
- class CfnProgramPropsMixin.AudienceMediaProperty(*, alternate_media=None, audience=None)
Bases:
objectAn 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor audience_media_property = mediatailor.CfnProgramPropsMixin.AudienceMediaProperty( alternate_media=[mediatailor.CfnProgramPropsMixin.AlternateMediaProperty( ad_breaks=[mediatailor.CfnProgramPropsMixin.AdBreakProperty( ad_break_metadata=[mediatailor.CfnProgramPropsMixin.KeyValuePairProperty( key="key", value="value" )], message_type="messageType", offset_millis=123, slate=mediatailor.CfnProgramPropsMixin.SlateSourceProperty( source_location_name="sourceLocationName", vod_source_name="vodSourceName" ), splice_insert_message=mediatailor.CfnProgramPropsMixin.SpliceInsertMessageProperty( avail_num=123, avails_expected=123, splice_event_id=123, unique_program_id=123 ), time_signal_message=mediatailor.CfnProgramPropsMixin.TimeSignalMessageProperty( segmentation_descriptors=[mediatailor.CfnProgramPropsMixin.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.CfnProgramPropsMixin.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.
- audience
The Audience defined in AudienceMedia.
ClipRangeProperty
- class CfnProgramPropsMixin.ClipRangeProperty(*, end_offset_millis=None, start_offset_millis=None)
Bases:
objectClip 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor clip_range_property = mediatailor.CfnProgramPropsMixin.ClipRangeProperty( end_offset_millis=123, start_offset_millis=123 )
Attributes
- end_offset_millis
The end offset of the clip range, in milliseconds.
- start_offset_millis
The start offset of the clip range, in milliseconds.
KeyValuePairProperty
- class CfnProgramPropsMixin.KeyValuePairProperty(*, key=None, value=None)
Bases:
objectFor SCTE35_ENHANCED output, defines a key and corresponding value.
- Parameters:
key (
Optional[str]) – The key.value (
Optional[str]) – The value.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor key_value_pair_property = mediatailor.CfnProgramPropsMixin.KeyValuePairProperty( key="key", value="value" )
Attributes
- key
The key.
ScheduleConfigurationProperty
- class CfnProgramPropsMixin.ScheduleConfigurationProperty(*, clip_range=None, transition=None)
Bases:
objectSchedule configuration parameters.
- Parameters:
clip_range (
Union[IResolvable,ClipRangeProperty,Dict[str,Any],None]) – Clip range configuration for the VOD source associated with the program.transition (
Union[IResolvable,TransitionProperty,Dict[str,Any],None]) – Program transition configuration.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor schedule_configuration_property = mediatailor.CfnProgramPropsMixin.ScheduleConfigurationProperty( clip_range=mediatailor.CfnProgramPropsMixin.ClipRangeProperty( end_offset_millis=123, start_offset_millis=123 ), transition=mediatailor.CfnProgramPropsMixin.TransitionProperty( duration_millis=123, relative_position="relativePosition", relative_program="relativeProgram", scheduled_start_time_millis=123, type="type" ) )
Attributes
- clip_range
Clip range configuration for the VOD source associated with the program.
- transition
Program transition configuration.
SegmentationDescriptorProperty
- class CfnProgramPropsMixin.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:
objectThe 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor segmentation_descriptor_property = mediatailor.CfnProgramPropsMixin.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.
- segmentation_event_id
The Event Identifier to assign.
- segmentation_type_id
The Type Identifier to assign.
- segmentation_upid
The Upid to assign.
- segmentation_upid_type
The Upid Type to assign.
- segments_expected
The number of segments expected.
- sub_segment_num
The sub-segment number to assign.
- sub_segments_expected
The number of sub-segments expected.
SlateSourceProperty
- class CfnProgramPropsMixin.SlateSourceProperty(*, source_location_name=None, vod_source_name=None)
Bases:
objectSlate 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor slate_source_property = mediatailor.CfnProgramPropsMixin.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.
- vod_source_name
The slate VOD source name.
SpliceInsertMessageProperty
- class CfnProgramPropsMixin.SpliceInsertMessageProperty(*, avail_num=None, avails_expected=None, splice_event_id=None, unique_program_id=None)
Bases:
objectSplice 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor splice_insert_message_property = mediatailor.CfnProgramPropsMixin.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.
- avails_expected
This is written to splice_insert.avails_expected.
- splice_event_id
This is written to splice_insert.splice_event_id.
- unique_program_id
This is written to splice_insert.unique_program_id.
TimeSignalMessageProperty
- class CfnProgramPropsMixin.TimeSignalMessageProperty(*, segmentation_descriptors=None)
Bases:
objectThe 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor time_signal_message_property = mediatailor.CfnProgramPropsMixin.TimeSignalMessageProperty( segmentation_descriptors=[mediatailor.CfnProgramPropsMixin.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).
TransitionProperty
- class CfnProgramPropsMixin.TransitionProperty(*, duration_millis=None, relative_position=None, relative_program=None, scheduled_start_time_millis=None, type=None)
Bases:
objectProgram transition configuration.
- Parameters:
duration_millis (
Union[int,float,None]) – The duration of the live program in seconds.relative_position (
Optional[str]) – The position where this program will be inserted relative to the RelativePosition.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.type (
Optional[str]) – Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor transition_property = mediatailor.CfnProgramPropsMixin.TransitionProperty( duration_millis=123, relative_position="relativePosition", relative_program="relativeProgram", scheduled_start_time_millis=123, type="type" )
Attributes
- duration_millis
The duration of the live program in seconds.
- relative_position
The position where this program will be inserted relative to the RelativePosition.
- relative_program
The name of the program that this program will be inserted next to.
- scheduled_start_time_millis
The date and time that the program is scheduled to start, in epoch milliseconds.
- type
Defines when the program plays in the schedule.
You can set the value to ABSOLUTE or RELATIVE.