@aws-cdk_aws-ivs-alpha.Channel

class Channel (construct) ๐Ÿ”น

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

Implements 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

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

Properties

NameTypeDescription
channelArn๐Ÿ”นstringThe channel ARN.
channelIngestEndpoint๐Ÿ”นstringChannel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
channelPlaybackUrl๐Ÿ”นstringChannel playback URL.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe 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: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
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.