# CfnChannelProps

Properties for defining a `CfnChannel`.

Extends: CfnChannelProps
Used as props by: CfnChannel

- Source: Generated code
- Type last changed: v2.272.0 · 30 Sep 2026

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

- `appInstanceArn`: string (required) — The ARN of the AppInstance that contains the channel.

- `channelId`: string — The ID of the channel.

  When omitted, the service generates a UUID.

- `chimeBearer`: string (required) — 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.

- `elasticChannelConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnChannel.ElasticChannelConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_chime.CfnChannel.ElasticChannelConfigurationProperty.html) — 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.

- `expirationSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnChannel.ExpirationSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_chime.CfnChannel.ExpirationSettingsProperty.html) — Settings 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.

  Cannot be combined with ElasticChannelConfiguration.

- `metadata`: string — The metadata of the channel.

- `mode`: string — 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.

- `moderatorArns`: string[] — The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.

- `name`: string (required) — The name of the channel.

- `privacy`: string — 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.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The tags for the channel.