Package software.amazon.awscdk.services.kinesisvideo

Class CfnSignalingChannel.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisvideo.CfnSignalingChannel.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSignalingChannel>

Enclosing class:

CfnSignalingChannel

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

A fluent builder for CfnSignalingChannel.

Method Summary

Modifier and Type	Method	Description
CfnSignalingChannel	build()
static CfnSignalingChannel.Builder	create(software.constructs.Construct scope, String id)
CfnSignalingChannel.Builder	messageTtlSeconds(Number messageTtlSeconds)	The period of time (in seconds) a signaling channel retains undelivered messages before they are discarded.
CfnSignalingChannel.Builder	name(String name)	A name for the signaling channel that you are creating.
CfnSignalingChannel.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnSignalingChannel.Builder	type(String type)	A type of the signaling channel that you are creating.

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 CfnSignalingChannel.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 CfnSignalingChannel.Builder.

messageTtlSeconds

@Stability(Stable)
public CfnSignalingChannel.Builder messageTtlSeconds(Number messageTtlSeconds)

The period of time (in seconds) a signaling channel retains undelivered messages before they are discarded.

Use API_UpdateSignalingChannel to update this value.

Parameters:

messageTtlSeconds - The period of time (in seconds) a signaling channel retains undelivered messages before they are discarded. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-messagettlseconds

name

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

A name for the signaling channel that you are creating.

It must be unique for each AWS account and AWS Region .

Parameters:

name - A name for the signaling channel that you are creating. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnSignalingChannel.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-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-tags

type

@Stability(Stable)
public CfnSignalingChannel.Builder type(String type)

A type of the signaling channel that you are creating.

Currently, SINGLE_MASTER is the only supported channel type.

Parameters:

type - A type of the signaling channel that you are creating. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSignalingChannel build()

Specified by:

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

Returns:

a newly built instance of CfnSignalingChannel.