class Channel (construct) 🔹

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

Implements IConstruct, IConstruct, IDependable, IResource, IChannel

A new IVS channel.

Example

const myChannel = new ivs.Channel(this, 'Channel');

Initializer

new Channel(scope: Construct, id: string, props?: ChannelProps)

Parameters

• scope Construct
• id string
• props ChannelProps

Construct Props

Name	Type	Description
authorized?🔹	boolean	Whether the channel is authorized.
latencyMode?🔹	LatencyMode	Channel latency mode.
name?🔹	string	Channel name.
type?🔹	ChannelType	The 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

---

latencyMode?🔹

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

Channel latency mode.

---

name?🔹

Type: string (optional, default: None)

Channel name.

---

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

Properties

Name	Type	Description
channelArn🔹	string	The channel ARN.
channelIngestEndpoint🔹	string	Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
channelPlaybackUrl🔹	string	Channel playback URL.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	ConstructNode	The construct tree node associated with this construct.
stack🔹	Stack	The stack in which this resource is defined.

---

channelArn🔹

Type: string

The channel ARN.

For example: arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

---

channelIngestEndpoint🔹

Type: string

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

For example: a1b2c3d4e5f6.global-contribute.live-video.net

---

channelPlaybackUrl🔹

Type: string

Channel playback URL.

For example: https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addStreamKey(id)🔹	Adds a stream key for this IVS Channel.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromChannelArn(scope, id, channelArn)🔹	Import an existing channel.

---

addStreamKey(id)🔹

public addStreamKey(id: string): StreamKey

Parameters

• id string

Returns

• StreamKey

Adds a stream key for this IVS Channel.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromChannelArn(scope, id, channelArn)🔹

public static fromChannelArn(scope: Construct, id: string, channelArn: string): IChannel

Parameters

• scope Construct
• id string
• channelArn string

Returns

• IChannel

Import an existing channel.