interface CfnChannelProps

Language	Type name
.NET	`Amazon.CDK.AWS.IVS.CfnChannelProps`
Java	`software.amazon.awscdk.services.ivs.CfnChannelProps`
Python	`aws_cdk.aws_ivs.CfnChannelProps`
TypeScript	`@aws-cdk/aws-ivs` » `CfnChannelProps`

Properties for defining a CfnChannel.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ivs from '@aws-cdk/aws-ivs';
const cfnChannelProps: ivs.CfnChannelProps = {
  authorized: false,
  insecureIngest: false,
  latencyMode: 'latencyMode',
  name: 'name',
  recordingConfigurationArn: 'recordingConfigurationArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties

Name	Type	Description
authorized?	`boolean \|` `IResolvable`	Whether the channel is authorized.
insecureIngest?	`boolean \|` `IResolvable`	Whether the channel allows insecure RTMP ingest.
latencyMode?	`string`	Channel latency mode. Valid values:.
name?	`string`	Channel name.
recordingConfigurationArn?	`string`	The ARN of a RecordingConfiguration resource.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.
type?	`string`	The channel type, which determines the allowable resolution and bitrate.

authorized?

Type: boolean | IResolvable (optional)

Whether the channel is authorized.

Default : false

insecureIngest?

Type: boolean | IResolvable (optional)

Whether the channel allows insecure RTMP ingest.

Default : false

latencyMode?

Type: string (optional)

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.

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

Default : LOW

name?

Type: string (optional)

Channel name.

recordingConfigurationArn?

Type: string (optional)

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)

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

type?

Type: string (optional)

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

If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

STANDARD : Video is transcoded: multiple qualities are generated from the original input to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
BASIC : Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Default : STANDARD