CfnChannelPropsMixin

class aws_cdk.cfn_property_mixins.aws_mediapackagev2.CfnChannelPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a channel to receive content.

After it’s created, a channel provides static input URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might occur. Use these URLs to configure the outputs of your upstream encoder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html
CloudformationResource:: AWS::MediaPackageV2::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.cfn_property_mixins import aws_mediapackagev2 as mediapackagev2
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_channel_props_mixin = mediapackagev2.CfnChannelPropsMixin(mediapackagev2.CfnChannelMixinProps(
    channel_group_name="channelGroupName",
    channel_name="channelName",
    description="description",
    input_switch_configuration=mediapackagev2.CfnChannelPropsMixin.InputSwitchConfigurationProperty(
        mqcs_input_switching=False,
        preferred_input=123
    ),
    input_type="inputType",
    multiview_configuration=mediapackagev2.CfnChannelPropsMixin.MultiviewConfigurationProperty(
        available_layouts=["availableLayouts"],
        available_sources=["availableSources"]
    ),
    output_header_configuration=mediapackagev2.CfnChannelPropsMixin.OutputHeaderConfigurationProperty(
        publish_mqcs=False
    ),
    output_locking_mode="outputLockingMode",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:

props (Union[CfnChannelMixinProps, 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 = ['channelGroupName', 'channelName', 'description', 'inputSwitchConfiguration', 'inputType', 'multiviewConfiguration', 'outputHeaderConfiguration', 'outputLockingMode', 'tags']

Static Methods

classmethod is_mixin(x)

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.

IngestEndpointProperty

class CfnChannelPropsMixin.IngestEndpointProperty(*, id=None, url=None)

Bases: object

The input URL where the source stream should be sent.

Parameters:

id (Optional[str]) – The identifier associated with the ingest endpoint of the channel.
url (Optional[str]) – The URL associated with the ingest endpoint of the channel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-ingestendpoint.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.cfn_property_mixins import aws_mediapackagev2 as mediapackagev2

ingest_endpoint_property = mediapackagev2.CfnChannelPropsMixin.IngestEndpointProperty(
    id="id",
    url="url"
)

Attributes

id

The identifier associated with the ingest endpoint of the channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-ingestendpoint.html#cfn-mediapackagev2-channel-ingestendpoint-id

url

The URL associated with the ingest endpoint of the channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-ingestendpoint.html#cfn-mediapackagev2-channel-ingestendpoint-url

InputSwitchConfigurationProperty

class CfnChannelPropsMixin.InputSwitchConfigurationProperty(*, mqcs_input_switching=None, preferred_input=None)

Bases: object

The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.

Parameters:

mqcs_input_switching (Union[bool, IResolvable, None]) – When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is false. This setting is valid only when InputType is CMAF .
preferred_input (Union[int, float, None]) – For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don’t specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-inputswitchconfiguration.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.cfn_property_mixins import aws_mediapackagev2 as mediapackagev2

input_switch_configuration_property = mediapackagev2.CfnChannelPropsMixin.InputSwitchConfigurationProperty(
    mqcs_input_switching=False,
    preferred_input=123
)

Attributes

mqcs_input_switching

When true, AWS Elemental MediaPackage performs input switching based on the MQCS.

Default is false. This setting is valid only when InputType is CMAF .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-inputswitchconfiguration.html#cfn-mediapackagev2-channel-inputswitchconfiguration-mqcsinputswitching

preferred_input

For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores.

Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don’t specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-inputswitchconfiguration.html#cfn-mediapackagev2-channel-inputswitchconfiguration-preferredinput

MultiviewConfigurationProperty

class CfnChannelPropsMixin.MultiviewConfigurationProperty(*, available_layouts=None, available_sources=None)

Bases: object

A multiview channel composites video from several source channels into a single tiled output stream. Players receive one standard HLS or DASH stream instead of several separate streams. This setting is required when InputType is MULTIVIEW, and can’t be set for any other input type.

Parameters:

available_layouts (Optional[Sequence[str]]) – Only the layouts that you list here are available. Each layout must appear at most once.
available_sources (Optional[Sequence[str]]) – Each source channel must be in the same channel group as the multiview channel, and must have an InputType of CMAF. Only the channels that you list here are available as tiles.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-multiviewconfiguration.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.cfn_property_mixins import aws_mediapackagev2 as mediapackagev2

multiview_configuration_property = mediapackagev2.CfnChannelPropsMixin.MultiviewConfigurationProperty(
    available_layouts=["availableLayouts"],
    available_sources=["availableSources"]
)

Attributes

available_layouts

Only the layouts that you list here are available. Each layout must appear at most once.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-multiviewconfiguration.html#cfn-mediapackagev2-channel-multiviewconfiguration-availablelayouts

available_sources

Each source channel must be in the same channel group as the multiview channel, and must have an InputType of CMAF. Only the channels that you list here are available as tiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-multiviewconfiguration.html#cfn-mediapackagev2-channel-multiviewconfiguration-availablesources

OutputHeaderConfigurationProperty

class CfnChannelPropsMixin.OutputHeaderConfigurationProperty(*, publish_mqcs=None)

Bases: object

The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.

Parameters:: publish_mqcs (Union[bool, IResolvable, None]) – When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when InputType is CMAF .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-outputheaderconfiguration.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.cfn_property_mixins import aws_mediapackagev2 as mediapackagev2

output_header_configuration_property = mediapackagev2.CfnChannelPropsMixin.OutputHeaderConfigurationProperty(
    publish_mqcs=False
)

Attributes

publish_mqcs

When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN.

This setting is valid only when InputType is CMAF .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-outputheaderconfiguration.html#cfn-mediapackagev2-channel-outputheaderconfiguration-publishmqcs