Package software.amazon.awscdk.services.ivs.alpha

Class Channel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ivs.alpha.Channel

All Implemented Interfaces:

IResource, IChannel, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:51.837Z")
@Stability(Experimental)
public class Channel
extends Resource
implements IChannel

(experimental) A new IVS channel.

Example:

 Channel myRtmpChannel = Channel.Builder.create(this, "myRtmpChannel")
         .type(ChannelType.STANDARD)
         .insecureIngest(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Channel.Builder	(experimental) A fluent builder for Channel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ivs.alpha.IChannel

IChannel.Jsii$Default, IChannel.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Channel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Channel(software.amazon.jsii.JsiiObjectRef objRef)
	Channel(software.constructs.Construct scope, String id)
	Channel(software.constructs.Construct scope, String id, ChannelProps props)

Method Summary

Modifier and Type	Method	Description
StreamKey	addStreamKey(String id)	(experimental) Adds a stream key for this IVS Channel.
static IChannel	fromChannelArn(software.constructs.Construct scope, String id, String channelArn)	(experimental) Import an existing channel.
String	getChannelArn()	(experimental) The channel ARN.
String	getChannelIngestEndpoint()	(experimental) Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
String	getChannelPlaybackUrl()	(experimental) Channel playback URL.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Experimental)
public static final String PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

Constructor Details

Channel

protected Channel(software.amazon.jsii.JsiiObjectRef objRef)

Channel

protected Channel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Channel

@Stability(Experimental)
public Channel(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ChannelProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Channel

@Stability(Experimental)
public Channel(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromChannelArn

@Stability(Experimental)
@NotNull
public static IChannel fromChannelArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String channelArn)

(experimental) Import an existing channel.

Parameters:

scope - This parameter is required.

id - This parameter is required.

channelArn - This parameter is required.

addStreamKey

@Stability(Experimental)
@NotNull
public StreamKey addStreamKey(@NotNull
 String id)

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

Specified by:

addStreamKey in interface IChannel

Parameters:

id - This parameter is required.

getChannelArn

@Stability(Experimental)
@NotNull
public String getChannelArn()

(experimental) The channel ARN.

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

Specified by:

getChannelArn in interface IChannel

getChannelIngestEndpoint

@Stability(Experimental)
@NotNull
public String getChannelIngestEndpoint()

(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

getChannelPlaybackUrl

@Stability(Experimental)
@NotNull
public String getChannelPlaybackUrl()

(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