CfnChannelPropsMixin

class aws_cdk.mixins_preview.aws_mediatailor.mixins.CfnChannelPropsMixin(props, *, strategy=None)

Bases: Mixin

The configuration parameters for a channel.

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html
CloudformationResource:: AWS::MediaTailor::Channel
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

cfn_channel_props_mixin = mediatailor_mixins.CfnChannelPropsMixin(mediatailor_mixins.CfnChannelMixinProps(
    audiences=["audiences"],
    channel_name="channelName",
    filler_slate=mediatailor_mixins.CfnChannelPropsMixin.SlateSourceProperty(
        source_location_name="sourceLocationName",
        vod_source_name="vodSourceName"
    ),
    log_configuration=mediatailor_mixins.CfnChannelPropsMixin.LogConfigurationForChannelProperty(
        log_types=["logTypes"]
    ),
    outputs=[mediatailor_mixins.CfnChannelPropsMixin.RequestOutputItemProperty(
        dash_playlist_settings=mediatailor_mixins.CfnChannelPropsMixin.DashPlaylistSettingsProperty(
            manifest_window_seconds=123,
            min_buffer_time_seconds=123,
            min_update_period_seconds=123,
            suggested_presentation_delay_seconds=123
        ),
        hls_playlist_settings=mediatailor_mixins.CfnChannelPropsMixin.HlsPlaylistSettingsProperty(
            ad_markup_type=["adMarkupType"],
            manifest_window_seconds=123
        ),
        manifest_name="manifestName",
        source_group="sourceGroup"
    )],
    playback_mode="playbackMode",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tier="tier",
    time_shift_configuration=mediatailor_mixins.CfnChannelPropsMixin.TimeShiftConfigurationProperty(
        max_time_delay_seconds=123
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::MediaTailor::Channel.

Parameters:

props (Union[CfnChannelMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['audiences', 'channelName', 'fillerSlate', 'logConfiguration', 'outputs', 'playbackMode', 'tags', 'tier', 'timeShiftConfiguration']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DashPlaylistSettingsProperty

class CfnChannelPropsMixin.DashPlaylistSettingsProperty(*, manifest_window_seconds=None, min_buffer_time_seconds=None, min_update_period_seconds=None, suggested_presentation_delay_seconds=None)

Bases: object

Dash manifest configuration parameters.

Parameters:

manifest_window_seconds (Union[int, float, None]) – The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
min_buffer_time_seconds (Union[int, float, None]) – Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
min_update_period_seconds (Union[int, float, None]) – Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
suggested_presentation_delay_seconds (Union[int, float, None]) – Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

dash_playlist_settings_property = mediatailor_mixins.CfnChannelPropsMixin.DashPlaylistSettingsProperty(
    manifest_window_seconds=123,
    min_buffer_time_seconds=123,
    min_update_period_seconds=123,
    suggested_presentation_delay_seconds=123
)

Attributes

manifest_window_seconds

The total duration (in seconds) of each manifest.

Minimum value: 30 seconds. Maximum value: 3600 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-manifestwindowseconds

min_buffer_time_seconds

Minimum amount of content (measured in seconds) that a player must keep available in the buffer.

Minimum value: 2 seconds. Maximum value: 60 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minbuffertimeseconds

min_update_period_seconds

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

Minimum value: 2 seconds. Maximum value: 60 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minupdateperiodseconds

suggested_presentation_delay_seconds

Amount of time (in seconds) that the player should be from the live point at the end of the manifest.

Minimum value: 2 seconds. Maximum value: 60 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-suggestedpresentationdelayseconds

HlsPlaylistSettingsProperty

class CfnChannelPropsMixin.HlsPlaylistSettingsProperty(*, ad_markup_type=None, manifest_window_seconds=None)

Bases: object

HLS playlist configuration parameters.

Parameters:

ad_markup_type (Optional[Sequence[str]]) – Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
manifest_window_seconds (Union[int, float, None]) – The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

hls_playlist_settings_property = mediatailor_mixins.CfnChannelPropsMixin.HlsPlaylistSettingsProperty(
    ad_markup_type=["adMarkupType"],
    manifest_window_seconds=123
)

Attributes

ad_markup_type

Determines the type of SCTE 35 tags to use in ad markup.

Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html#cfn-mediatailor-channel-hlsplaylistsettings-admarkuptype

manifest_window_seconds

The total duration (in seconds) of each manifest.

Minimum value: 30 seconds. Maximum value: 3600 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html#cfn-mediatailor-channel-hlsplaylistsettings-manifestwindowseconds

LogConfigurationForChannelProperty

class CfnChannelPropsMixin.LogConfigurationForChannelProperty(*, log_types=None)

Bases: object

The log configuration for the channel.

Parameters:: log_types (Optional[Sequence[str]]) – The log types.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-logconfigurationforchannel.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

log_configuration_for_channel_property = mediatailor_mixins.CfnChannelPropsMixin.LogConfigurationForChannelProperty(
    log_types=["logTypes"]
)

Attributes

log_types

The log types.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-logconfigurationforchannel.html#cfn-mediatailor-channel-logconfigurationforchannel-logtypes

RequestOutputItemProperty

class CfnChannelPropsMixin.RequestOutputItemProperty(*, dash_playlist_settings=None, hls_playlist_settings=None, manifest_name=None, source_group=None)

Bases: object

The output configuration for this channel.

Parameters:

dash_playlist_settings (Union[IResolvable, DashPlaylistSettingsProperty, Dict[str, Any], None]) – DASH manifest configuration parameters.
hls_playlist_settings (Union[IResolvable, HlsPlaylistSettingsProperty, Dict[str, Any], None]) – HLS playlist configuration parameters.
manifest_name (Optional[str]) – The name of the manifest for the channel. The name appears in the PlaybackUrl .
source_group (Optional[str]) – A string used to match which HttpPackageConfiguration is used for each VodSource .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

request_output_item_property = mediatailor_mixins.CfnChannelPropsMixin.RequestOutputItemProperty(
    dash_playlist_settings=mediatailor_mixins.CfnChannelPropsMixin.DashPlaylistSettingsProperty(
        manifest_window_seconds=123,
        min_buffer_time_seconds=123,
        min_update_period_seconds=123,
        suggested_presentation_delay_seconds=123
    ),
    hls_playlist_settings=mediatailor_mixins.CfnChannelPropsMixin.HlsPlaylistSettingsProperty(
        ad_markup_type=["adMarkupType"],
        manifest_window_seconds=123
    ),
    manifest_name="manifestName",
    source_group="sourceGroup"
)

Attributes

dash_playlist_settings

DASH manifest configuration parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-dashplaylistsettings

hls_playlist_settings

HLS playlist configuration parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-hlsplaylistsettings

manifest_name

The name of the manifest for the channel.

The name appears in the PlaybackUrl .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-manifestname

source_group

A string used to match which HttpPackageConfiguration is used for each VodSource .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-sourcegroup

SlateSourceProperty

class CfnChannelPropsMixin.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. The VOD source must already exist in a source location before it can be used for slate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

slate_source_property = mediatailor_mixins.CfnChannelPropsMixin.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-channel-slatesource.html#cfn-mediatailor-channel-slatesource-sourcelocationname

vod_source_name

The slate VOD source name.

The VOD source must already exist in a source location before it can be used for slate.

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

TimeShiftConfigurationProperty

class CfnChannelPropsMixin.TimeShiftConfigurationProperty(*, max_time_delay_seconds=None)

Bases: object

The configuration for time-shifted viewing.

Parameters:: max_time_delay_seconds (Union[int, float, None]) – The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-timeshiftconfiguration.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

time_shift_configuration_property = mediatailor_mixins.CfnChannelPropsMixin.TimeShiftConfigurationProperty(
    max_time_delay_seconds=123
)

Attributes

max_time_delay_seconds

The maximum time delay for time-shifted viewing.

The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-timeshiftconfiguration.html#cfn-mediatailor-channel-timeshiftconfiguration-maxtimedelayseconds