CfnChannelProps Struct
Properties for defining a CfnChannel.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_chime as chime } from 'aws-cdk-lib';
const cfnChannelProps: chime.CfnChannelProps = {
appInstanceArn: 'appInstanceArn',
chimeBearer: 'chimeBearer',
name: 'name',
// the properties below are optional
channelId: 'channelId',
elasticChannelConfiguration: {
maximumSubChannels: 123,
minimumMembershipPercentage: 123,
targetMembershipsPerSubChannel: 123,
},
expirationSettings: {
expirationCriterion: 'expirationCriterion',
expirationDays: 123,
},
memberArns: ['memberArns'],
metadata: 'metadata',
mode: 'mode',
moderatorArns: ['moderatorArns'],
privacy: 'privacy',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
appInstanceArnstringapp_instance_arnstrappInstanceArnStringAppInstanceArnstringAppInstanceArn*stringrequired#The ARN of the AppInstance that contains the channel.
The ID of the channel.
When omitted, the service generates a UUID.
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.
elasticChannelConfigurationIResolvable | CfnChannel.ElasticChannelConfigurationPropertyelastic_channel_configurationtyping.Union[IResolvable, ElasticChannelConfigurationProperty]elasticChannelConfigurationIResolvableElasticChannelConfigurationIResolvableElasticChannelConfigurationinterface{}#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.
expirationSettingsIResolvable | CfnChannel.ExpirationSettingsPropertyexpiration_settingstyping.Union[IResolvable, ExpirationSettingsProperty]expirationSettingsIResolvableExpirationSettingsIResolvableExpirationSettingsinterface{}#Settings that control the interval after which the channel is automatically deleted.
memberArnsstring[]member_arnstyping.List[str]memberArnsList<String>MemberArnsstring[]MemberArns*[]*string#The ARNs of the AppInstanceUsers to add to the channel as members when it is created.
Cannot be combined with ElasticChannelConfiguration.
The metadata of the channel.
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.
moderatorArnsstring[]moderator_arnstyping.List[str]moderatorArnsList<String>ModeratorArnsstring[]ModeratorArns*[]*string#The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.
The name of the channel.
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.