AWS::Chime::Channel

Chime Channel

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.

Properties

12 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
AppInstanceArn
string
RequiredCreate-only
ChimeBearer
string
RequiredCreate-only
Name
string
Required
ChannelId
string
Create-only
ElasticChannelConfiguration
ElasticChannelConfiguration
Create-only
ExpirationSettings
ExpirationSettings
MemberArns
Array<string>
Create-onlyWrite-only
Metadata
string
Mode
string
ModeratorArns
Array<string>
Create-onlyWrite-only
Privacy
string
Create-only
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ArnstringThe ARN of the channel.
ChannelFlowArnstringThe ARN of the channel flow.
CreatedByIdentity-
CreatedTimestampstringThe time at which the channel was created.
LastMessageTimestampstringThe time at which a member sent the last message in the channel.
LastUpdatedTimestampstringThe time at which the channel was last updated.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Chime::Channel

Resources:
  MyResource:
    Type: AWS::Chime::Channel
    Properties:
      AppInstanceArn: "arn:aws:service:region:account:resource"
      ChimeBearer: "value"
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

chime:CreateChannelchime:CreateChannelMembershipchime:CreateChannelModeratorchime:PutChannelExpirationSettingschime:TagResource

read

chime:DescribeChannelchime:ListTagsForResource

update

chime:UpdateChannelchime:PutChannelExpirationSettingschime:TagResourcechime:UntagResourcechime:ListTagsForResourcechime:DescribeChannel

delete

chime:DeleteChannelchime:DescribeChannelchime:ListTagsForResource

list

chime:ListChannels

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceChime
Properties18
Required3
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AppInstanceArnChannelIdChimeBearerElasticChannelConfigurationMemberArnsModeratorArnsPrivacy

Related Resources

External Links