Package software.amazon.awscdk.services.ivs

Class CfnChannel.Builder

java.lang.Object

software.amazon.awscdk.services.ivs.CfnChannel.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnChannel>

Enclosing class:

CfnChannel

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

A fluent builder for CfnChannel.

Method Summary

Modifier and Type	Method	Description
CfnChannel.Builder	authorized(Boolean authorized)	Whether the channel is authorized.
CfnChannel.Builder	authorized(IResolvable authorized)	Whether the channel is authorized.
CfnChannel	build()
CfnChannel.Builder	containerFormat(String containerFormat)	Indicates which content-packaging format is used (MPEG-TS or fMP4).
static CfnChannel.Builder	create(software.constructs.Construct scope, String id)
CfnChannel.Builder	insecureIngest(Boolean insecureIngest)	Whether the channel allows insecure RTMP ingest.
CfnChannel.Builder	insecureIngest(IResolvable insecureIngest)	Whether the channel allows insecure RTMP ingest.
CfnChannel.Builder	latencyMode(String latencyMode)	Channel latency mode.
CfnChannel.Builder	multitrackInputConfiguration(IResolvable multitrackInputConfiguration)	Object specifying multitrack input configuration.
CfnChannel.Builder	multitrackInputConfiguration(CfnChannel.MultitrackInputConfigurationProperty multitrackInputConfiguration)	Object specifying multitrack input configuration.
CfnChannel.Builder	name(String name)	Channel name.
CfnChannel.Builder	preset(String preset)	An optional transcode preset for the channel.
CfnChannel.Builder	recordingConfigurationArn(String recordingConfigurationArn)	The ARN of a RecordingConfiguration resource.
CfnChannel.Builder	recordingConfigurationArn(IRecordingConfigurationRef recordingConfigurationArn)	The ARN of a RecordingConfiguration resource.
CfnChannel.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnChannel.Builder	type(String type)	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 Details

create

@Stability(Stable)
public static CfnChannel.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnChannel.Builder.

authorized

@Stability(Stable)
public CfnChannel.Builder authorized(Boolean authorized)

Whether the channel is authorized.

Default : false

Default: - false

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-authorized

authorized

@Stability(Stable)
public CfnChannel.Builder authorized(IResolvable authorized)

Whether the channel is authorized.

Default : false

Default: - false

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-authorized

containerFormat

@Stability(Stable)
public CfnChannel.Builder containerFormat(String containerFormat)

Indicates which content-packaging format is used (MPEG-TS or fMP4).

If multitrackInputConfiguration is specified and enabled is true , then containerFormat is required and must be set to FRAGMENTED_MP4 . Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4 . Default: TS .

Default: - "TS"

Parameters:

containerFormat - Indicates which content-packaging format is used (MPEG-TS or fMP4). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-containerformat

insecureIngest

@Stability(Stable)
public CfnChannel.Builder insecureIngest(Boolean insecureIngest)

Whether the channel allows insecure RTMP ingest.

Default : false

Default: - false

Parameters:

insecureIngest - Whether the channel allows insecure RTMP ingest. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-insecureingest

insecureIngest

@Stability(Stable)
public CfnChannel.Builder insecureIngest(IResolvable insecureIngest)

Whether the channel allows insecure RTMP ingest.

Default : false

Default: - false

Parameters:

insecureIngest - Whether the channel allows insecure RTMP ingest. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-insecureingest

latencyMode

@Stability(Stable)
public CfnChannel.Builder latencyMode(String 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

Default: - "LOW"

Parameters:

latencyMode - Channel latency mode. Valid values:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-latencymode

multitrackInputConfiguration

@Stability(Stable)
public CfnChannel.Builder multitrackInputConfiguration(IResolvable multitrackInputConfiguration)

Object specifying multitrack input configuration.

Default: no multitrack input configuration is specified.

Parameters:

multitrackInputConfiguration - Object specifying multitrack input configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-multitrackinputconfiguration

multitrackInputConfiguration

@Stability(Stable)
public CfnChannel.Builder multitrackInputConfiguration(CfnChannel.MultitrackInputConfigurationProperty multitrackInputConfiguration)

Object specifying multitrack input configuration.

Default: no multitrack input configuration is specified.

Parameters:

multitrackInputConfiguration - Object specifying multitrack input configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-multitrackinputconfiguration

name

@Stability(Stable)
public CfnChannel.Builder name(String name)

Channel name.

Default: - "-"

Parameters:

name - Channel name. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-name

preset

@Stability(Stable)
public CfnChannel.Builder preset(String preset)

An optional transcode preset for the channel.

This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY . For other channel types ( BASIC and STANDARD ), preset is the empty string ("").

Parameters:

preset - An optional transcode preset for the channel. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-preset

recordingConfigurationArn

@Stability(Stable)
public CfnChannel.Builder recordingConfigurationArn(String 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)

Default: - ""

Parameters:

recordingConfigurationArn - The ARN of a RecordingConfiguration resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-recordingconfigurationarn

recordingConfigurationArn

@Stability(Stable)
public CfnChannel.Builder recordingConfigurationArn(IRecordingConfigurationRef 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)

Default: - ""

Parameters:

recordingConfigurationArn - The ARN of a RecordingConfiguration resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-recordingconfigurationarn

tags

@Stability(Stable)
public CfnChannel.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-tags

type

@Stability(Stable)
public CfnChannel.Builder type(String 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. For details, see Channel Types .

Default : STANDARD

Default: - "STANDARD"

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-type

build

@Stability(Stable)
public CfnChannel build()

Specified by:

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

Returns:

a newly built instance of CfnChannel.