CfnChannelPropsMixin

class aws_cdk.cfn_property_mixins.aws_chime.CfnChannelPropsMixin(props, *, strategy=None)

Bases: 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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html
CloudformationResource:: AWS::Chime::Channel
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# 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
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_channel_props_mixin = chime.CfnChannelPropsMixin(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=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:

props (Union[CfnChannelMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['appInstanceArn', 'channelId', 'chimeBearer', 'elasticChannelConfiguration', 'expirationSettings', 'memberArns', 'metadata', 'mode', 'moderatorArns', 'name', 'privacy', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ElasticChannelConfigurationProperty

class CfnChannelPropsMixin.ElasticChannelConfigurationProperty(*, maximum_sub_channels=None, minimum_membership_percentage=None, target_memberships_per_sub_channel=None)

Bases: object

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.

Parameters:

maximum_sub_channels (Union[int, float, None]) – The maximum number of SubChannels allowed in the elastic channel.
minimum_membership_percentage (Union[int, float, None]) – The minimum allowed percentage of TargetMembershipsPerSubChannel users, used to balance members across SubChannels.
target_memberships_per_sub_channel (Union[int, float, None]) – The maximum number of members allowed in a SubChannel.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

elastic_channel_configuration_property = chime.CfnChannelPropsMixin.ElasticChannelConfigurationProperty(
    maximum_sub_channels=123,
    minimum_membership_percentage=123,
    target_memberships_per_sub_channel=123
)

Attributes

maximum_sub_channels

The maximum number of SubChannels allowed in the elastic channel.

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

minimum_membership_percentage

The minimum allowed percentage of TargetMembershipsPerSubChannel users, used to balance members across SubChannels.

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

target_memberships_per_sub_channel

The maximum number of members allowed in a SubChannel.

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

ExpirationSettingsProperty

class CfnChannelPropsMixin.ExpirationSettingsProperty(*, expiration_criterion=None, expiration_days=None)

Bases: object

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

Parameters:

expiration_criterion (Optional[str]) – The condition the expiration period is measured from.
expiration_days (Union[int, float, None]) – The period in days after which the system automatically deletes the channel.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

expiration_settings_property = chime.CfnChannelPropsMixin.ExpirationSettingsProperty(
    expiration_criterion="expirationCriterion",
    expiration_days=123
)

Attributes

expiration_criterion

The condition the expiration period is measured from.

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

expiration_days

The period in days after which the system automatically deletes the channel.

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

IdentityProperty

class CfnChannelPropsMixin.IdentityProperty(*, arn=None, name=None)

Bases: object

The AppInstanceUser or AppInstanceBot that created the channel.

Parameters:

arn (Optional[str]) – The ARN in an identity.
name (Optional[str]) – The name in an identity.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

identity_property = chime.CfnChannelPropsMixin.IdentityProperty(
    arn="arn",
    name="name"
)

Attributes

arn

The ARN in an identity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channel-identity.html#cfn-chime-channel-identity-arn

name

The name in an identity.

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