cells

Creates, updates, deletes or gets a cell resource or lists cells in a region

Overview

Name	cells
Type	Resource
Description	The API Schema for AWS Route53 Recovery Readiness Cells.
Id	aws.route53recoveryreadiness.cells

Fields

Name	Datatype	Description
cell_name	string	The name of the cell to create.
cell_arn	string	The Amazon Resource Name (ARN) of the cell.
cells	array	A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions.
parent_readiness_scopes	array	The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
tags	array	A collection of tags associated with a 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 cells in a region.

SELECT
region,
cell_name,
cell_arn,
cells,
parent_readiness_scopes,
tags
FROM aws.route53recoveryreadiness.cells
WHERE region = 'us-east-1';

Gets all properties from an individual cell.

SELECT
region,
cell_name,
cell_arn,
cells,
parent_readiness_scopes,
tags
FROM aws.route53recoveryreadiness.cells
WHERE region = 'us-east-1' AND data__Identifier = '<CellName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.route53recoveryreadiness.cells (
 CellName,
 Cells,
 Tags,
 region
)
SELECT 
'{{ CellName }}',
 '{{ Cells }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.route53recoveryreadiness.cells (
 CellName,
 Cells,
 Tags,
 region
)
SELECT 
 '{{ CellName }}',
 '{{ Cells }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cell
    props:
      - name: CellName
        value: '{{ CellName }}'
      - name: Cells
        value:
          - '{{ Cells[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.route53recoveryreadiness.cells
WHERE data__Identifier = '<CellName>'
AND region = 'us-east-1';

Permissions

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

Create

route53-recovery-readiness:CreateCell,
route53-recovery-readiness:GetCell,
route53-recovery-readiness:ListTagsForResources,
route53-recovery-readiness:TagResource

Read

route53-recovery-readiness:GetCell,
route53-recovery-readiness:ListTagsForResources

Update

route53-recovery-readiness:GetCell,
route53-recovery-readiness:ListTagsForResources,
route53-recovery-readiness:TagResource,
route53-recovery-readiness:UntagResource,
route53-recovery-readiness:UpdateCell

Delete

route53-recovery-readiness:DeleteCell,
route53-recovery-readiness:GetCell

List

route53-recovery-readiness:ListCells