software.amazon.awscdk.services.ivs

Class CfnChannelProps.Builder

java.lang.Object

software.amazon.awscdk.services.ivs.CfnChannelProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnChannelProps>

Enclosing interface:

CfnChannelProps

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

A builder for CfnChannelProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnChannelProps.Builder	authorized(Boolean authorized) Sets the value of CfnChannelProps.getAuthorized()
CfnChannelProps.Builder	authorized(IResolvable authorized) Sets the value of CfnChannelProps.getAuthorized()
CfnChannelProps	build() Builds the configured instance.
CfnChannelProps.Builder	latencyMode(String latencyMode) Sets the value of CfnChannelProps.getLatencyMode()
CfnChannelProps.Builder	name(String name) Sets the value of CfnChannelProps.getName()
CfnChannelProps.Builder	recordingConfigurationArn(String recordingConfigurationArn) Sets the value of CfnChannelProps.getRecordingConfigurationArn()
CfnChannelProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnChannelProps.getTags()
CfnChannelProps.Builder	type(String type) Sets the value of CfnChannelProps.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=Stable)
public CfnChannelProps.Builder authorized(Boolean authorized)

Sets the value of CfnChannelProps.getAuthorized()

Parameters:

authorized - Whether the channel is authorized. Default : false

Returns:

this

authorized

@Stability(value=Stable)
public CfnChannelProps.Builder authorized(IResolvable authorized)

Sets the value of CfnChannelProps.getAuthorized()

Parameters:

authorized - Whether the channel is authorized. Default : false

Returns:

this

latencyMode

@Stability(value=Stable)
public CfnChannelProps.Builder latencyMode(String latencyMode)

Sets the value of CfnChannelProps.getLatencyMode()

Parameters:

latencyMode - Channel latency mode. Valid values:.

• NORMAL : Use NORMAL to broadcast and deliver live video up to Full HD.
• LOW : Use LOW for near real-time interactions with viewers.

In the console, LOW and NORMAL correspond to Ultra-low and Standard , respectively.

Default : LOW

Returns:

this

name

@Stability(value=Stable)
public CfnChannelProps.Builder name(String name)

Sets the value of CfnChannelProps.getName()

Parameters:

name - Channel name.

Returns:

this

recordingConfigurationArn

@Stability(value=Stable)
public CfnChannelProps.Builder recordingConfigurationArn(String recordingConfigurationArn)

Sets the value of CfnChannelProps.getRecordingConfigurationArn()

Parameters:

recordingConfigurationArn - The ARN of a RecordingConfiguration resource. An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the RecordingConfiguration resource for more information and an example.

Default : "" (empty string, recording is disabled)

Returns:

this

tags

@Stability(value=Stable)
public CfnChannelProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnChannelProps.getTags()

Parameters:

tags - An array of key-value pairs to apply to this resource. For more information, see Tag .

Returns:

this

type

@Stability(value=Stable)
public CfnChannelProps.Builder type(String type)

Sets the value of CfnChannelProps.getType()

Parameters:

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

• STANDARD : Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
• BASIC : delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Default : STANDARD

Returns:

this

build

@Stability(value=Stable)
public CfnChannelProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnChannelProps

Throws:

NullPointerException - if any required attribute was not provided