ChannelProps

class aws_cdk.aws_ivs.ChannelProps(*, authorized=None, latency_mode=None, name=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

  • latency_mode (Optional[LatencyMode]) – (experimental) Channel latency mode. Default: LatencyMode.LOW

  • name (Optional[str]) – (experimental) Channel name. Default: - None

  • 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_channel = ivs.Channel(self, "Channel",
    authorized=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

latency_mode

(experimental) Channel latency mode.

Default

LatencyMode.LOW

Stability

experimental

name

(experimental) Channel name.

Default
  • None

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