Channel

class aws_cdk.aws_ivs.Channel(scope, id, *, authorized=None, latency_mode=None, name=None, type=None)

Bases: aws_cdk.core.Resource

(experimental) A new IVS channel.

Stability

experimental

Example:

my_channel = ivs.Channel(self, "Channel")
Parameters
  • scope (Construct) –

  • id (str) –

  • authorized (Optional[bool]) – (experimental) 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 Default: false

  • latency_mode (Optional[LatencyMode]) – (experimental) Channel latency mode. Default: LatencyMode.LOW

  • name (Optional[str]) – (experimental) Channel name. Default: - None

  • type (Optional[ChannelType]) – (experimental) The channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream will disconnect immediately Default: ChannelType.STANDARD

Stability

experimental

Methods

add_stream_key(id)

(experimental) Adds a stream key for this IVS Channel.

Parameters

id (str) –

Stability

experimental

Return type

StreamKey

apply_removal_policy(policy)

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

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

channel_arn

(experimental) The channel ARN.

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

Stability

experimental

Return type

str

channel_ingest_endpoint

(experimental) 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

Stability

experimental

Attribute

true

Return type

str

channel_playback_url

(experimental) Channel playback URL.

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

Stability

experimental

Attribute

true

Return type

str

env

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.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_channel_arn(scope, id, channel_arn)

(experimental) Import an existing channel.

Parameters
  • scope (Construct) –

  • id (str) –

  • channel_arn (str) –

Stability

experimental

Return type

IChannel

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool