software.amazon.awscdk.services.ivs

Class Channel.Builder

java.lang.Object

software.amazon.awscdk.services.ivs.Channel.Builder

Enclosing class:

Channel

public static final class Channel.Builder
extends java.lang.Object

(experimental) A fluent builder for Channel.

Method Summary

Modifier and Type	Method and Description
Channel.Builder	authorized(java.lang.Boolean authorized) (experimental) Whether the channel is authorized.
Channel	build()
static Channel.Builder	create(software.constructs.Construct scope, java.lang.String id)
Channel.Builder	latencyMode(LatencyMode latencyMode) (experimental) Channel latency mode.
Channel.Builder	name(java.lang.String name) (experimental) Channel name.
Channel.Builder	type(ChannelType type) (experimental) The channel type, which determines the allowable resolution and bitrate.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Channel.Builder create(software.constructs.Construct scope,
                                     java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Channel.Builder.

authorized

public Channel.Builder authorized(java.lang.Boolean authorized)

(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

Parameters:

authorized - Whether the channel is authorized. This parameter is required.

Returns:

this

latencyMode

public Channel.Builder latencyMode(LatencyMode latencyMode)

(experimental) Channel latency mode.

Default: LatencyMode.LOW

Parameters:

latencyMode - Channel latency mode. This parameter is required.

Returns:

this

name

public Channel.Builder name(java.lang.String name)

(experimental) Channel name.

Default: - None

Parameters:

name - Channel name. This parameter is required.

Returns:

this

type

public Channel.Builder type(ChannelType type)

(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

Parameters:

type - The channel type, which determines the allowable resolution and bitrate. This parameter is required.

Returns:

this

build

public Channel build()