rooms

Creates, updates, deletes or gets a room resource or lists rooms in a region

Overview

Name	rooms
Type	Resource
Description	Resource type definition for AWS::IVSChat::Room.
Id	aws.ivschat.rooms

Fields

Name	Datatype	Description
arn	string	Room ARN is automatically generated on creation and assigned as the unique identifier.
id	string	The system-generated ID of the room.
name	string	The name of the room. The value does not need to be unique.
logging_configuration_identifiers	array	Array of logging configuration identifiers attached to the room.
maximum_message_length	integer	The maximum number of characters in a single message.
maximum_message_rate_per_second	integer	The maximum number of messages per second that can be sent to the room.
message_review_handler	object	Configuration information for optional review of messages.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all rooms in a region.

SELECT
region,
arn,
id,
name,
logging_configuration_identifiers,
maximum_message_length,
maximum_message_rate_per_second,
message_review_handler,
tags
FROM aws.ivschat.rooms
WHERE region = 'us-east-1';

Gets all properties from an individual room.

SELECT
region,
arn,
id,
name,
logging_configuration_identifiers,
maximum_message_length,
maximum_message_rate_per_second,
message_review_handler,
tags
FROM aws.ivschat.rooms
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new room resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ivschat.rooms (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ivschat.rooms (
 Name,
 LoggingConfigurationIdentifiers,
 MaximumMessageLength,
 MaximumMessageRatePerSecond,
 MessageReviewHandler,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ LoggingConfigurationIdentifiers }}',
 '{{ MaximumMessageLength }}',
 '{{ MaximumMessageRatePerSecond }}',
 '{{ MessageReviewHandler }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: room
    props:
      - name: Name
        value: '{{ Name }}'
      - name: LoggingConfigurationIdentifiers
        value:
          - '{{ LoggingConfigurationIdentifiers[0] }}'
      - name: MaximumMessageLength
        value: '{{ MaximumMessageLength }}'
      - name: MaximumMessageRatePerSecond
        value: '{{ MaximumMessageRatePerSecond }}'
      - name: MessageReviewHandler
        value:
          FallbackResult: '{{ FallbackResult }}'
          Uri: '{{ Uri }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ivschat.rooms
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the rooms resource, the following permissions are required:

Create

ivschat:CreateRoom,
ivschat:TagResource

Read

ivschat:GetRoom,
ivschat:ListTagsForResource

Update

ivschat:UpdateRoom,
ivschat:TagResource,
ivschat:UntagResource,
ivschat:ListTagsForResource

Delete

ivschat:DeleteRoom,
ivschat:UntagResource

List

ivschat:ListRooms,
ivschat:ListTagsForResource