Package software.amazon.awscdk.services.chime

Class CfnChannelProps.Builder

java.lang.Object

software.amazon.awscdk.services.chime.CfnChannelProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnChannelProps>

Enclosing interface:

CfnChannelProps

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

A builder for CfnChannelProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnChannelProps.Builder	appInstanceArn(String appInstanceArn)	Sets the value of CfnChannelProps.getAppInstanceArn()
CfnChannelProps	build()	Builds the configured instance.
CfnChannelProps.Builder	channelId(String channelId)	Sets the value of CfnChannelProps.getChannelId()
CfnChannelProps.Builder	chimeBearer(String chimeBearer)	Sets the value of CfnChannelProps.getChimeBearer()
CfnChannelProps.Builder	elasticChannelConfiguration(IResolvable elasticChannelConfiguration)	Sets the value of CfnChannelProps.getElasticChannelConfiguration()
CfnChannelProps.Builder	elasticChannelConfiguration(CfnChannel.ElasticChannelConfigurationProperty elasticChannelConfiguration)	Sets the value of CfnChannelProps.getElasticChannelConfiguration()
CfnChannelProps.Builder	expirationSettings(IResolvable expirationSettings)	Sets the value of CfnChannelProps.getExpirationSettings()
CfnChannelProps.Builder	expirationSettings(CfnChannel.ExpirationSettingsProperty expirationSettings)	Sets the value of CfnChannelProps.getExpirationSettings()
CfnChannelProps.Builder	memberArns(List<String> memberArns)	Sets the value of CfnChannelProps.getMemberArns()
CfnChannelProps.Builder	metadata(String metadata)	Sets the value of CfnChannelProps.getMetadata()
CfnChannelProps.Builder	mode(String mode)	Sets the value of CfnChannelProps.getMode()
CfnChannelProps.Builder	moderatorArns(List<String> moderatorArns)	Sets the value of CfnChannelProps.getModeratorArns()
CfnChannelProps.Builder	name(String name)	Sets the value of CfnChannelProps.getName()
CfnChannelProps.Builder	privacy(String privacy)	Sets the value of CfnChannelProps.getPrivacy()
CfnChannelProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnChannelProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

appInstanceArn

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

Sets the value of CfnChannelProps.getAppInstanceArn()

Parameters:

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

Returns:

this

chimeBearer

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

Sets the value of CfnChannelProps.getChimeBearer()

Parameters:

chimeBearer - The ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel. This parameter is required. 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.

Returns:

this

name

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

Sets the value of CfnChannelProps.getName()

Parameters:

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

Returns:

this

channelId

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

Sets the value of CfnChannelProps.getChannelId()

Parameters:

channelId - The ID of the channel. When omitted, the service generates a UUID.

Returns:

this

elasticChannelConfiguration

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

Sets the value of CfnChannelProps.getElasticChannelConfiguration()

Parameters:

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.

Returns:

this

elasticChannelConfiguration

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

Sets the value of CfnChannelProps.getElasticChannelConfiguration()

Parameters:

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.

Returns:

this

expirationSettings

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

Sets the value of CfnChannelProps.getExpirationSettings()

Parameters:

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

Returns:

this

expirationSettings

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

Sets the value of CfnChannelProps.getExpirationSettings()

Parameters:

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

Returns:

this

memberArns

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

Sets the value of CfnChannelProps.getMemberArns()

Parameters:

memberArns - The ARNs of the AppInstanceUsers to add to the channel as members when it is created. Cannot be combined with ElasticChannelConfiguration.

Returns:

this

metadata

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

Sets the value of CfnChannelProps.getMetadata()

Parameters:

metadata - The metadata of the channel.

Returns:

this

mode

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

Sets the value of CfnChannelProps.getMode()

Parameters:

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.

Returns:

this

moderatorArns

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

Sets the value of CfnChannelProps.getModeratorArns()

Parameters:

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

Returns:

this

privacy

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

Sets the value of CfnChannelProps.getPrivacy()

Parameters:

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.

Returns:

this

tags

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

Sets the value of CfnChannelProps.getTags()

Parameters:

tags - The tags for the channel.

Returns:

this

build

@Stability(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