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	awscc.route53recoveryreadiness.cells

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
cell_name	string	The name of the cell to create.
region	string	AWS region.

For more information, see AWS::Route53RecoveryReadiness::Cell.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual cell.

SELECT
  region,
  cell_name,
  cell_arn,
  cells,
  parent_readiness_scopes,
  tags
FROM awscc.route53recoveryreadiness.cells
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cell_name }}';

list (identifiers only)

Lists all cells in a region.

SELECT
  region,
  cell_name
FROM awscc.route53recoveryreadiness.cells_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.route53recoveryreadiness.cells (
  CellName,
  Cells,
  Tags,
  region
)
SELECT
  '{{ cell_name }}',
  '{{ cells }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.route53recoveryreadiness.cells (
  CellName,
  Cells,
  Tags,
  region
)
SELECT
  '{{ cell_name }}',
  '{{ cells }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: cell
  props:
    - name: cell_name
      value: '{{ cell_name }}'
    - name: cells
      value:
        - '{{ cells[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.route53recoveryreadiness.cells
SET PatchDocument = string('{{ {
    "Cells": cells,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cell_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.route53recoveryreadiness.cells
WHERE
  Identifier = '{{ cell_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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