@aws-cdk_aws-ivs-alpha.ChannelProps

interface ChannelProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Ivs.Alpha.ChannelProps
Gogithub.com/aws/aws-cdk-go/awscdkivsalpha/v2#ChannelProps
Javasoftware.amazon.awscdk.services.ivs.alpha.ChannelProps
Pythonaws_cdk.aws_ivs_alpha.ChannelProps
TypeScript (source)@aws-cdk/aws-ivs-alpha ยป ChannelProps

Properties for creating a new Channel.

Example

const myChannel = new ivs.Channel(this, 'Channel', {
  authorized: true, // default value is false
});

Properties

NameTypeDescription
authorized?๐Ÿ”นbooleanWhether the channel is authorized.
channelName?๐Ÿ”นstringA name for the channel.
latencyMode?๐Ÿ”นLatencyModeChannel latency mode.
type?๐Ÿ”นChannelTypeThe channel type, which determines the allowable resolution and bitrate.

authorized?๐Ÿ”น

Type: boolean (optional, default: false)

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


channelName?๐Ÿ”น

Type: string (optional, default: Automatically generated name)

A name for the channel.


latencyMode?๐Ÿ”น

Type: LatencyMode (optional, default: LatencyMode.LOW)

Channel latency mode.


type?๐Ÿ”น

Type: ChannelType (optional, default: ChannelType.STANDARD)

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

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