class CfnChannelPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Chime.CfnChannelPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awschime#CfnChannelPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.chime.CfnChannelPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_chime.CfnChannelPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_chime » CfnChannelPropsMixin

Implements IMixin

Extends Mixin

Creates a channel in an Amazon Chime SDK Messaging AppInstance.

Members of a channel exchange messages within it. Every channel operation is performed on behalf of an AppInstanceUser or AppInstanceBot, whose ARN is supplied as ChimeBearer and forms part of the channel's CloudFormation identifier.

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/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnChannelPropsMixin = new chime.CfnChannelPropsMixin({
  appInstanceArn: 'appInstanceArn',
  channelId: 'channelId',
  chimeBearer: 'chimeBearer',
  elasticChannelConfiguration: {
    maximumSubChannels: 123,
    minimumMembershipPercentage: 123,
    targetMembershipsPerSubChannel: 123,
  },
  expirationSettings: {
    expirationCriterion: 'expirationCriterion',
    expirationDays: 123,
  },
  memberArns: ['memberArns'],
  metadata: 'metadata',
  mode: 'mode',
  moderatorArns: ['moderatorArns'],
  name: 'name',
  privacy: 'privacy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnChannelPropsMixin(props: CfnChannelMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnChannelMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Chime::Channel.

Properties

Name	Type	Description
props	CfnChannelMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnChannelMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.