chimesdkmessaging/aws.sdk.kotlin.services.chimesdkmessaging.model/CreateChannelRequest/Builder

Builder

class Builder

Properties

appInstanceArn

var appInstanceArn: String?

The ARN of the channel request.

channelId

var channelId: String?

An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.

chimeBearer

var chimeBearer: String?

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

clientRequestToken

var clientRequestToken: String?

The client token for the request. An Idempotency token.

elasticChannelConfiguration

var elasticChannelConfiguration: ElasticChannelConfiguration?

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

expirationSettings

var expirationSettings: ExpirationSettings?

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

memberArns

var memberArns: List<String>?

The ARNs of the channel members in the request.

metadata

var metadata: String?

The metadata of the creation request. Limited to 1KB and UTF-8.

mode

var mode: ChannelMode?

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

moderatorArns

var moderatorArns: List<String>?

The ARNs of the channel moderators in the request.

name

var name: String?

The name of the channel.

privacy

var privacy: ChannelPrivacy?

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

Functions

elasticChannelConfiguration

fun elasticChannelConfiguration(block: ElasticChannelConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.chimesdkmessaging.model.ElasticChannelConfiguration inside the given block

expirationSettings

fun expirationSettings(block: ExpirationSettings.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.chimesdkmessaging.model.ExpirationSettings inside the given block