2.272.0

interface CfnChannelProps

LanguageType name
.NETAmazon.CDK.AWS.Chime.CfnChannelProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awschime#CfnChannelProps
Javasoftware.amazon.awscdk.services.chime.CfnChannelProps
Pythonaws_cdk.aws_chime.CfnChannelProps
TypeScript aws-cdk-lib » aws_chime » CfnChannelProps

Properties for defining a CfnChannel.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html

Example

// 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

NameTypeDescription
appInstanceArnstringThe ARN of the AppInstance that contains the channel.
chimeBearerstringThe ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel.
namestringThe name of the channel.
channelId?stringThe ID of the channel.
elasticChannelConfiguration?IResolvable | ElasticChannelConfigurationPropertyThe attributes required to configure and create an elastic channel.
expirationSettings?IResolvable | ExpirationSettingsPropertySettings that control the interval after which the channel is automatically deleted.
memberArns?string[]The ARNs of the AppInstanceUsers to add to the channel as members when it is created.
metadata?stringThe metadata of the channel.
mode?stringThe channel mode.
moderatorArns?string[]The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.
privacy?stringThe channel's privacy level.
tags?CfnTag[]The tags for the channel.

appInstanceArn

Type: string

The ARN of the AppInstance that contains the channel.

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

chimeBearer

Type: string

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.

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

name

Type: string

The name of the channel.

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

channelId?

Type: string (optional)

The ID of the channel.

When omitted, the service generates a UUID.

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

elasticChannelConfiguration?

Type: IResolvable | ElasticChannelConfigurationProperty (optional)

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.

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

expirationSettings?

Type: IResolvable | ExpirationSettingsProperty (optional)

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

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

memberArns?

Type: string[] (optional)

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

Cannot be combined with ElasticChannelConfiguration.

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

metadata?

Type: string (optional)

The metadata of the channel.

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

mode?

Type: string (optional)

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.

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

moderatorArns?

Type: string[] (optional)

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

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

privacy?

Type: string (optional)

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.

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

tags?

Type: CfnTag[] (optional)

The tags for the channel.

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

← PreviousNext →