Package software.amazon.awscdk.services.chime

Class CfnChannel.Builder

java.lang.Object

software.amazon.awscdk.services.chime.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	appInstanceArn(String appInstanceArn)	The ARN of the AppInstance that contains the channel.
CfnChannel	build()
CfnChannel.Builder	channelId(String channelId)	The ID of the channel.
CfnChannel.Builder	chimeBearer(String chimeBearer)	The ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel.
static CfnChannel.Builder	create(software.constructs.Construct scope, String id)
CfnChannel.Builder	elasticChannelConfiguration(IResolvable elasticChannelConfiguration)	The attributes required to configure and create an elastic channel.
CfnChannel.Builder	elasticChannelConfiguration(CfnChannel.ElasticChannelConfigurationProperty elasticChannelConfiguration)	The attributes required to configure and create an elastic channel.
CfnChannel.Builder	expirationSettings(IResolvable expirationSettings)	Settings that control the interval after which the channel is automatically deleted.
CfnChannel.Builder	expirationSettings(CfnChannel.ExpirationSettingsProperty expirationSettings)	Settings that control the interval after which the channel is automatically deleted.
CfnChannel.Builder	memberArns(List<String> memberArns)	The ARNs of the AppInstanceUsers to add to the channel as members when it is created.
CfnChannel.Builder	metadata(String metadata)	The metadata of the channel.
CfnChannel.Builder	mode(String mode)	The channel mode.
CfnChannel.Builder	moderatorArns(List<String> moderatorArns)	The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.
CfnChannel.Builder	name(String name)	The name of the channel.
CfnChannel.Builder	privacy(String privacy)	The channel's privacy level.
CfnChannel.Builder	tags(List<? extends CfnTag> tags)	The tags for the channel.

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.

appInstanceArn

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

The ARN of the AppInstance that contains the channel.

Parameters:

appInstanceArn - The ARN of the AppInstance that contains the channel. This parameter is required.

Returns:

this

See Also:

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

chimeBearer

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

The ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel.

Whichever of the two creates a channel automatically becomes one of its moderators, so the same ARN can subsequently read, update and delete the channel.

Parameters:

chimeBearer - The ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel. This parameter is required.

Returns:

this

See Also:

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

name

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

The name of the channel.

Parameters:

name - The name of the channel. This parameter is required.

Returns:

this

See Also:

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

channelId

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

The ID of the channel.

When omitted, the service generates a UUID.

Parameters:

channelId - The ID of the channel. This parameter is required.

Returns:

this

See Also:

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

elasticChannelConfiguration

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

The attributes required to configure and create an elastic channel.

An elastic channel must use RESTRICTED mode, cannot be created with MemberArns, and is available only in some regions.

Parameters:

elasticChannelConfiguration - The attributes required to configure and create an elastic channel. This parameter is required.

Returns:

this

See Also:

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

elasticChannelConfiguration

@Stability(Stable)
public CfnChannel.Builder elasticChannelConfiguration(CfnChannel.ElasticChannelConfigurationProperty elasticChannelConfiguration)

The attributes required to configure and create an elastic channel.

An elastic channel must use RESTRICTED mode, cannot be created with MemberArns, and is available only in some regions.

Parameters:

elasticChannelConfiguration - The attributes required to configure and create an elastic channel. This parameter is required.

Returns:

this

See Also:

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

expirationSettings

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

Settings that control the interval after which the channel is automatically deleted.

Parameters:

expirationSettings - Settings that control the interval after which the channel is automatically deleted. This parameter is required.

Returns:

this

See Also:

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

expirationSettings

@Stability(Stable)
public CfnChannel.Builder expirationSettings(CfnChannel.ExpirationSettingsProperty expirationSettings)

Settings that control the interval after which the channel is automatically deleted.

Parameters:

expirationSettings - Settings that control the interval after which the channel is automatically deleted. This parameter is required.

Returns:

this

See Also:

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

memberArns

@Stability(Stable)
public CfnChannel.Builder memberArns(List<String> memberArns)

The ARNs of the AppInstanceUsers to add to the channel as members when it is created.

Cannot be combined with ElasticChannelConfiguration.

Parameters:

memberArns - The ARNs of the AppInstanceUsers to add to the channel as members when it is created. This parameter is required.

Returns:

this

See Also:

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

metadata

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

The metadata of the channel.

Parameters:

metadata - The metadata of the channel. This parameter is required.

Returns:

this

See Also:

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

mode

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

The channel mode.

In an UNRESTRICTED channel, members can add themselves and other members; in a RESTRICTED channel, only administrators and moderators can add members. An elastic channel must be RESTRICTED.

Parameters:

mode - The channel mode. This parameter is required.

Returns:

this

See Also:

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

moderatorArns

@Stability(Stable)
public CfnChannel.Builder moderatorArns(List<String> moderatorArns)

The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.

Parameters:

moderatorArns - The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created. This parameter is required.

Returns:

this

See Also:

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

privacy

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

The channel's privacy level.

A PUBLIC channel is discoverable by anyone in the AppInstance; a PRIVATE channel is not. Privacy cannot be changed after creation.

Parameters:

privacy - The channel's privacy level. This parameter is required.

Returns:

this

See Also:

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

tags

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

The tags for the channel.

Parameters:

tags - The tags for the channel. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnChannel build()

Specified by:

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

Returns:

a newly built instance of CfnChannel.