software.amazon.awscdk.services.ivs

Class ChannelProps.Builder

java.lang.Object

software.amazon.awscdk.services.ivs.ChannelProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ChannelProps>

Enclosing interface:

ChannelProps

@Stability(value=Experimental)
public static final class ChannelProps.Builder
extends Object
implements software.amazon.jsii.Builder<ChannelProps>

A builder for ChannelProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ChannelProps.Builder	authorized(Boolean authorized) Sets the value of ChannelProps.getAuthorized()
ChannelProps	build() Builds the configured instance.
ChannelProps.Builder	latencyMode(LatencyMode latencyMode) Sets the value of ChannelProps.getLatencyMode()
ChannelProps.Builder	name(String name) Sets the value of ChannelProps.getName()
ChannelProps.Builder	type(ChannelType type) Sets the value of ChannelProps.getType()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

authorized

@Stability(value=Experimental)
public ChannelProps.Builder authorized(Boolean authorized)

Sets the value of ChannelProps.getAuthorized()

Parameters:

authorized - 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

Returns:

this

latencyMode

@Stability(value=Experimental)
public ChannelProps.Builder latencyMode(LatencyMode latencyMode)

Sets the value of ChannelProps.getLatencyMode()

Parameters:

latencyMode - Channel latency mode.

Returns:

this

name

@Stability(value=Experimental)
public ChannelProps.Builder name(String name)

Sets the value of ChannelProps.getName()

Parameters:

name - Channel name.

Returns:

this

type

@Stability(value=Experimental)
public ChannelProps.Builder type(ChannelType type)

Sets the value of ChannelProps.getType()

Parameters:

type - The channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream will disconnect immediately

Returns:

this

build

@Stability(value=Experimental)
public ChannelProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ChannelProps>

Returns:

a new instance of ChannelProps

Throws:

NullPointerException - if any required attribute was not provided