CfnChannelPropsMixin

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

Bases: Mixin

The AWS::IVS::Channel resource specifies an channel.

A channel stores configuration information related to your live stream. For more information, see CreateChannel in the Amazon IVS Low-Latency Streaming API Reference . .. epigraph:

By default, the IVS API CreateChannel endpoint creates a stream key in addition to a channel. The  Channel resource *does not* create a stream key; to create a stream key, use the StreamKey resource instead.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html
CloudformationResource:: AWS::IVS::Channel
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# 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_ivs import mixins as ivs_mixins

cfn_channel_props_mixin = ivs_mixins.CfnChannelPropsMixin(ivs_mixins.CfnChannelMixinProps(
    authorized=False,
    container_format="containerFormat",
    insecure_ingest=False,
    latency_mode="latencyMode",
    multitrack_input_configuration=ivs_mixins.CfnChannelPropsMixin.MultitrackInputConfigurationProperty(
        enabled=False,
        maximum_resolution="maximumResolution",
        policy="policy"
    ),
    name="name",
    preset="preset",
    recording_configuration_arn="recordingConfigurationArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IVS::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 = ['authorized', 'containerFormat', 'insecureIngest', 'latencyMode', 'multitrackInputConfiguration', 'name', 'preset', 'recordingConfigurationArn', 'tags', 'type']

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

MultitrackInputConfigurationProperty

class CfnChannelPropsMixin.MultitrackInputConfigurationProperty(*, enabled=None, maximum_resolution=None, policy=None)

Bases: object

A complex type that specifies multitrack input configuration.

Parameters:

enabled (Union[bool, IResolvable, None]) – Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD . Setting enabled to true with any other channel type will cause an exception. If true , then policy , maximumResolution , and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4 . Default: false . Default: - false
maximum_resolution (Optional[str]) – Maximum resolution for multitrack input. Required if enabled is true .
policy (Optional[str]) – Indicates whether multitrack input is allowed or required. Required if enabled is true .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-channel-multitrackinputconfiguration.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_ivs import mixins as ivs_mixins

multitrack_input_configuration_property = ivs_mixins.CfnChannelPropsMixin.MultitrackInputConfigurationProperty(
    enabled=False,
    maximum_resolution="maximumResolution",
    policy="policy"
)

Attributes

enabled

Indicates whether multitrack input is enabled.

Can be set to true only if channel type is STANDARD . Setting enabled to true with any other channel type will cause an exception. If true , then policy , maximumResolution , and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4 . Default: false .

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-channel-multitrackinputconfiguration.html#cfn-ivs-channel-multitrackinputconfiguration-enabled

maximum_resolution

Maximum resolution for multitrack input.

Required if enabled is true .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-channel-multitrackinputconfiguration.html#cfn-ivs-channel-multitrackinputconfiguration-maximumresolution

policy

Indicates whether multitrack input is allowed or required.

Required if enabled is true .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-channel-multitrackinputconfiguration.html#cfn-ivs-channel-multitrackinputconfiguration-policy