@aws-cdk_aws-ivs-alpha.IChannel

interface IChannel ๐Ÿ”น

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

Implemented by Channel

Obtainable from Channel.fromChannelArn()

Represents an IVS Channel.

Properties

NameTypeDescription
channelArn๐Ÿ”นstringThe channel ARN.
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


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.

addStreamKey(id)๐Ÿ”น

public addStreamKey(id: string): StreamKey

Parameters

  • id string โ€” construct ID.

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