CfnChannel

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

Bases: CfnResource

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
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 import aws_chime as chime

cfn_channel = chime.CfnChannel(self, "MyCfnChannel",
    app_instance_arn="appInstanceArn",
    chime_bearer="chimeBearer",
    name="name",

    # the properties below are optional
    channel_id="channelId",
    elastic_channel_configuration=chime.CfnChannel.ElasticChannelConfigurationProperty(
        maximum_sub_channels=123,
        minimum_membership_percentage=123,
        target_memberships_per_sub_channel=123
    ),
    expiration_settings=chime.CfnChannel.ExpirationSettingsProperty(
        expiration_criterion="expirationCriterion",
        expiration_days=123
    ),
    member_arns=["memberArns"],
    metadata="metadata",
    mode="mode",
    moderator_arns=["moderatorArns"],
    privacy="privacy",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::Chime::Channel.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
app_instance_arn (str) – The ARN of the AppInstance that contains the channel.
chime_bearer (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.
name (str) – The name of the channel.
channel_id (Optional[str]) – The ID of the channel. When omitted, the service generates a UUID.
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.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:

target (CfnResource)
reason (Optional[str])

Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)

Parameters:: cdk_property_name (str)
Return type:: Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:: List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Deprecated:: Use removeResourceDependency instead
Stability:: deprecated
Return type:: None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Chime::Channel'

app_instance_arn: The ARN of the AppInstance that contains the channel.

attr_arn

The ARN of the channel.

CloudformationAttribute:: Arn

attr_channel_flow_arn

The ARN of the channel flow.

CloudformationAttribute:: ChannelFlowArn

attr_created_by

The AppInstanceUser or AppInstanceBot that created the channel.

CloudformationAttribute:: CreatedBy

attr_created_timestamp

The time at which the channel was created.

CloudformationAttribute:: CreatedTimestamp

attr_last_message_timestamp

The time at which a member sent the last message in the channel.

CloudformationAttribute:: LastMessageTimestamp

attr_last_updated_timestamp

The time at which the channel was last updated.

CloudformationAttribute:: LastUpdatedTimestamp

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

channel_id: The ID of the channel.

channel_ref: A reference to a Channel resource.

chime_bearer: The ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

elastic_channel_configuration: The attributes required to configure and create an elastic channel.

env

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

metadata: The metadata of the channel.

mode: The channel mode.

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

name: The name of the channel.

node: The tree node.

privacy: The channel’s privacy level.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: The tags for the channel.

Static Methods

classmethod arn_for_channel(resource)

Parameters:: resource (IChannelRef)
Return type:: str

classmethod is_cfn_channel(x)

Checks whether the given object is a CfnChannel.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

ElasticChannelConfigurationProperty

class CfnChannel.ElasticChannelConfigurationProperty(*, maximum_sub_channels, minimum_membership_percentage, target_memberships_per_sub_channel)

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]) – The maximum number of SubChannels allowed in the elastic channel.
minimum_membership_percentage (Union[int, float]) – The minimum allowed percentage of TargetMembershipsPerSubChannel users, used to balance members across SubChannels.
target_memberships_per_sub_channel (Union[int, float]) – 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 import aws_chime as chime

elastic_channel_configuration_property = chime.CfnChannel.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 CfnChannel.ExpirationSettingsProperty(*, expiration_criterion, expiration_days)

Bases: object

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

Parameters:

expiration_criterion (str) – The condition the expiration period is measured from.
expiration_days (Union[int, float]) – 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 import aws_chime as chime

expiration_settings_property = chime.CfnChannel.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 CfnChannel.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 import aws_chime as chime

identity_property = chime.CfnChannel.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