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	awscc.ivschat.rooms

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	Room ARN is automatically generated on creation and assigned as the unique identifier.
region	string	AWS region.

For more information, see AWS::IVSChat::Room.

Methods

Name	Resource	Accessible by	Required Params
create_resource	rooms	INSERT	, region
delete_resource	rooms	DELETE	Identifier, region
update_resource	rooms	UPDATE	Identifier, PatchDocument, region
list_resources	rooms_list_only	SELECT	region
get_resource	rooms	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.ivschat.rooms
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all rooms in a region.

SELECT
  region,
  arn
FROM awscc.ivschat.rooms_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.ivschat.rooms (
  Name,
  LoggingConfigurationIdentifiers,
  MaximumMessageLength,
  MaximumMessageRatePerSecond,
  MessageReviewHandler,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ logging_configuration_identifiers }}',
  '{{ maximum_message_length }}',
  '{{ maximum_message_rate_per_second }}',
  '{{ message_review_handler }}',
  '{{ 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: logging_configuration_identifiers
        value:
          - '{{ logging_configuration_identifiers[0] }}'
      - name: maximum_message_length
        value: '{{ maximum_message_length }}'
      - name: maximum_message_rate_per_second
        value: '{{ maximum_message_rate_per_second }}'
      - name: message_review_handler
        value:
          fallback_result: '{{ fallback_result }}'
          uri: '{{ uri }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ivschat.rooms
SET PatchDocument = string('{{ {
    "Name": name,
    "LoggingConfigurationIdentifiers": logging_configuration_identifiers,
    "MaximumMessageLength": maximum_message_length,
    "MaximumMessageRatePerSecond": maximum_message_rate_per_second,
    "MessageReviewHandler": message_review_handler,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ivschat.rooms
WHERE
  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