CfnChannelMixinProps

class aws_cdk.cfn_property_mixins.aws_chime.CfnChannelMixinProps(*, app_instance_arn=None, channel_id=None, chime_bearer=None, elastic_channel_configuration=None, expiration_settings=None, member_arns=None, metadata=None, mode=None, moderator_arns=None, name=None, privacy=None, tags=None)

Bases: object

Properties for CfnChannelPropsMixin.

Parameters:

app_instance_arn (Optional[str]) – The ARN of the AppInstance that contains the channel.
channel_id (Optional[str]) – The ID of the channel. When omitted, the service generates a UUID.
chime_bearer (Optional[str]) – 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.
elastic_channel_configuration (Union[IResolvable, ElasticChannelConfigurationProperty, Dict[str, Any], None]) – 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.
expiration_settings (Union[IResolvable, ExpirationSettingsProperty, Dict[str, Any], None]) – Settings that control the interval after which the channel is automatically deleted.
member_arns (Optional[Sequence[str]]) – The ARNs of the AppInstanceUsers to add to the channel as members when it is created. Cannot be combined with ElasticChannelConfiguration.
metadata (Optional[str]) – The metadata of the channel.
mode (Optional[str]) – 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.
moderator_arns (Optional[Sequence[str]]) – The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.
name (Optional[str]) – The name of the channel.
privacy (Optional[str]) – 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags for the channel.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_chime as chime

cfn_channel_mixin_props = chime.CfnChannelMixinProps(
    app_instance_arn="appInstanceArn",
    channel_id="channelId",
    chime_bearer="chimeBearer",
    elastic_channel_configuration=chime.CfnChannelPropsMixin.ElasticChannelConfigurationProperty(
        maximum_sub_channels=123,
        minimum_membership_percentage=123,
        target_memberships_per_sub_channel=123
    ),
    expiration_settings=chime.CfnChannelPropsMixin.ExpirationSettingsProperty(
        expiration_criterion="expirationCriterion",
        expiration_days=123
    ),
    member_arns=["memberArns"],
    metadata="metadata",
    mode="mode",
    moderator_arns=["moderatorArns"],
    name="name",
    privacy="privacy",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

app_instance_arn

The ARN of the AppInstance that contains the channel.

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

channel_id

The ID of the channel.

When omitted, the service generates a UUID.

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

chime_bearer

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-chimebearer

elastic_channel_configuration

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-elasticchannelconfiguration

expiration_settings

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

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

member_arns

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

Cannot be combined with ElasticChannelConfiguration.

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

metadata

The metadata of the channel.

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

mode

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-mode

moderator_arns

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

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

name

The name of the channel.

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

privacy

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-privacy

tags

The tags for the channel.

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