software.amazon.awscdk.services.ivs

Class Channel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ivs.Channel

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.405Z")
 @Stability(value=Experimental)
public class Channel
extends Resource
implements IChannel

(experimental) A new IVS channel.

Example:

 Channel myChannel = new Channel(this, "Channel");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.IChannel

IChannel.Jsii$Default, IChannel.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Channel

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

Channel

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

Channel

@Stability(value=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(value=Experimental)
public Channel(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromChannelArn

@Stability(value=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(value=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(value=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(value=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(value=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