ChannelProps

class aws_cdk.aws_ivs_alpha.ChannelProps(*, authorized=None, channel_name=None, insecure_ingest=None, latency_mode=None, preset=None, recording_configuration=None, type=None)

Bases: object

(experimental) Properties for creating a new Channel.

Parameters:

authorized (Optional[bool]) – (experimental) Whether the channel is authorized. If you wish to make an authorized channel, you will need to ensure that a PlaybackKeyPair has been uploaded to your account as this is used to validate the signed JWT that is required for authorization Default: false
channel_name (Optional[str]) – (experimental) A name for the channel. Default: Automatically generated name
insecure_ingest (Optional[bool]) – (experimental) Whether the channel allows insecure RTMP ingest. Default: false
latency_mode (Optional[LatencyMode]) – (experimental) Channel latency mode. Default: LatencyMode.LOW
preset (Optional[Preset]) – (experimental) An optional transcode preset for the channel. Can be used for ADVANCED_HD and ADVANCED_SD channel types. When LOW or STANDARD is used, the preset will be overridden and set to none regardless of the value provided. Default: - Preset.HIGHER_BANDWIDTH_DELIVERY if channelType is ADVANCED_SD or ADVANCED_HD, none otherwise
recording_configuration (Optional[IRecordingConfiguration]) – (experimental) A recording configuration for the channel. Default: - recording is disabled
type (Optional[ChannelType]) – (experimental) The channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream will disconnect immediately Default: ChannelType.STANDARD

Stability:

experimental

ExampleMetadata:

infused

Example:

my_rtmp_channel = ivs.Channel(self, "myRtmpChannel",
    type=ivs.ChannelType.STANDARD,
    insecure_ingest=True
)

Attributes

authorized

(experimental) Whether the channel is authorized.

If you wish to make an authorized channel, you will need to ensure that a PlaybackKeyPair has been uploaded to your account as this is used to validate the signed JWT that is required for authorization

Default:: false
Stability:: experimental

channel_name

(experimental) A name for the channel.

Default:: Automatically generated name
Stability:: experimental

insecure_ingest

(experimental) Whether the channel allows insecure RTMP ingest.

Default:: false
Stability:: experimental

latency_mode

(experimental) Channel latency mode.

Default:: LatencyMode.LOW
Stability:: experimental

preset

(experimental) An optional transcode preset for the channel.

Can be used for ADVANCED_HD and ADVANCED_SD channel types. When LOW or STANDARD is used, the preset will be overridden and set to none regardless of the value provided.

Default:

Preset.HIGHER_BANDWIDTH_DELIVERY if channelType is ADVANCED_SD or ADVANCED_HD, none otherwise

Stability:

experimental

recording_configuration

(experimental) A recording configuration for the channel.

Default:

recording is disabled

Stability:

experimental

type

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

If you exceed the allowable resolution or bitrate, the stream will disconnect immediately

Default:: ChannelType.STANDARD
Stability:: experimental