AWS::IVSChat::Room - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


The AWS::IVSChat::Room resource specifies an Amazon IVS room that allows clients to connect and pass messages. For more information, see CreateRoom in the Amazon Interactive Video Service Chat API Reference.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::IVSChat::Room", "Properties" : { "LoggingConfigurationIdentifiers" : [ String, ... ], "MaximumMessageLength" : Integer, "MaximumMessageRatePerSecond" : Integer, "MessageReviewHandler" : MessageReviewHandler, "Name" : String, "Tags" : [ Tag, ... ] } }


Type: AWS::IVSChat::Room Properties: LoggingConfigurationIdentifiers: - String MaximumMessageLength: Integer MaximumMessageRatePerSecond: Integer MessageReviewHandler: MessageReviewHandler Name: String Tags: - Tag



List of logging-configuration identifiers attached to the room.

Required: No

Type: Array of String

Minimum: 1 | 0

Maximum: 128 | 50

Update requires: No interruption


Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.

Required: No

Type: Integer

Minimum: 1

Maximum: 500

Update requires: No interruption


Maximum number of messages per second that can be sent to the room (by all clients).

Required: No

Type: Integer

Minimum: 1

Maximum: 10

Update requires: No interruption


Configuration information for optional review of messages.

Required: No

Type: MessageReviewHandler

Update requires: No interruption


Room name. The value does not need to be unique.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9-_]*$

Minimum: 0

Maximum: 128

Update requires: No interruption


An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the room ARN. For example:

{ "Ref": "myRoom" }

For the Amazon IVS room myRoom , Ref returns the room ARN.

For more information about using the Ref function, see Ref.


The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.


The room ARN. For example: arn:aws:ivschat:us-west-2:123456789012:room/abcdABCDefgh


The room ID. For example: abcdABCDefgh


Room Template Examples

The following examples specify an Amazon IVS Chat Room.


{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "Room": { "Type": "AWS::IVSChat::Room", "Properties": { "Name": "MyRoom", "Tags": [ { "Key": "MyKey", "Value": "MyValue" } ] } } }, "Outputs": { "RoomArn": { "Value": { "Ref": "Room" } }, "RoomId": { "Value": { "Fn::GetAtt": [ "Room", "Id" ] } } } }


AWSTemplateFormatVersion: 2010-09-09 Resources: Room: Type: AWS::IVSChat::Room Properties: Name: MyRoom Tags: - Key: MyKey Value: MyValue Outputs: RoomArn: Value: !Ref Room RoomId: Value: !GetAtt Room.Id

See also