CfnChannelProps

class aws_cdk.aws_ivs.CfnChannelProps(*, authorized=None, container_format=None, insecure_ingest=None, latency_mode=None, multitrack_input_configuration=None, name=None, preset=None, recording_configuration_arn=None, tags=None, type=None)

Bases: object

Properties for defining a CfnChannel.

Parameters:

authorized (Union[bool, IResolvable, None]) – Whether the channel is authorized. Default : false Default: - false
container_format (Optional[str]) – Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true , then containerFormat is required and must be set to FRAGMENTED_MP4 . Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4 . Default: TS . Default: - “TS”
insecure_ingest (Union[bool, IResolvable, None]) – Whether the channel allows insecure RTMP ingest. Default : false Default: - false
latency_mode (Optional[str]) – Channel latency mode. Valid values:. - NORMAL : Use NORMAL to broadcast and deliver live video up to Full HD. - LOW : Use LOW for near real-time interactions with viewers. .. epigraph:: In the console, LOW and NORMAL correspond to Ultra-low and Standard , respectively. Default : LOW Default: - “LOW”
multitrack_input_configuration (Union[IResolvable, MultitrackInputConfigurationProperty, Dict[str, Any], None]) – Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
name (Optional[str]) – Channel name. Default: - “-”
preset (Optional[str]) – An optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY . For other channel types ( BASIC and STANDARD ), preset is the empty string (“”).
recording_configuration_arn (Union[str, IRecordingConfigurationRef, None]) – The ARN of a RecordingConfiguration resource. An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the RecordingConfiguration resource for more information and an example. Default : “” (empty string, recording is disabled) Default: - “”
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
type (Optional[str]) – The channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. For details, see Channel Types . Default : STANDARD Default: - “STANDARD”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html

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 import aws_ivs as ivs

cfn_channel_props = ivs.CfnChannelProps(
    authorized=False,
    container_format="containerFormat",
    insecure_ingest=False,
    latency_mode="latencyMode",
    multitrack_input_configuration=ivs.CfnChannel.MultitrackInputConfigurationProperty(
        enabled=False,
        maximum_resolution="maximumResolution",
        policy="policy"
    ),
    name="name",
    preset="preset",
    recording_configuration_arn="recordingConfigurationArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
)

Attributes

authorized

Whether the channel is authorized.

Default : false

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-authorized

container_format

Indicates which content-packaging format is used (MPEG-TS or fMP4).

If multitrackInputConfiguration is specified and enabled is true , then containerFormat is required and must be set to FRAGMENTED_MP4 . Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4 . Default: TS .

Default:

“TS”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-containerformat

insecure_ingest

Whether the channel allows insecure RTMP ingest.

Default : false

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-insecureingest

latency_mode

.

NORMAL : Use NORMAL to broadcast and deliver live video up to Full HD.
LOW : Use LOW for near real-time interactions with viewers.

In the console, LOW and NORMAL correspond to Ultra-low and Standard , respectively.

Default : LOW

Default:

“LOW”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-latencymode

Type:

Channel latency mode. Valid values

multitrack_input_configuration

Object specifying multitrack input configuration.

Default: no multitrack input configuration is specified.

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

name

Channel name.

Default:

“-”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-name

preset

An optional transcode preset for the channel.

This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY . For other channel types ( BASIC and STANDARD ), preset is the empty string (“”).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-preset

recording_configuration_arn

The ARN of a RecordingConfiguration resource.

An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the RecordingConfiguration resource for more information and an example.

Default : “” (empty string, recording is disabled)

Default:

“”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-recordingconfigurationarn

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-tags

type

The channel type, which determines the allowable resolution and bitrate.

If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. For details, see Channel Types .

Default : STANDARD

Default:

“STANDARD”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-type