cells

Creates, updates, deletes, gets or lists a cells resource.

Overview

Name	cells
Type	Resource
Id	aws.route53_recovery_readiness.cells

Fields

The following fields are returned by SELECT queries:

get_cell

Name	Datatype	Description
cell_arn	string	The Amazon Resource Name (ARN) for the cell.
cell_name	string	The name of the cell. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
cells	array	A list of cell ARNs.
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	object	Tags on the resources.

list_cells

Name	Datatype	Description
cell_arn	string	The Amazon Resource Name (ARN) for the cell.
cell_name	string	The name of the cell. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
cells	array	A list of cell ARNs.
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	object	Tags on the resources.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cell	select	cell_name, region		Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.
list_cells	select	region	maxResults, nextToken	Lists the cells for an account.
create_cell	insert	region, CellName		Creates a cell in an account.
update_cell	update	cell_name, region		Updates a cell to replace the list of nested cells with a new list of nested cells.
delete_cell	delete	cell_name, region		Delete a cell. When successful, the response code is 204, with no response body.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cell_name	string	The name of the cell.
region	string	AWS region (default: us-east-1)
maxResults	integer	The number of objects that you want to return with this call.
nextToken	string	The token that identifies which batch of results you want to see.

SELECT examples

get_cell

Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.

SELECT
cell_arn,
cell_name,
cells,
parent_readiness_scopes,
tags
FROM aws.route53_recovery_readiness.cells
WHERE cell_name = '{{ cell_name }}' -- required
AND region = '{{ region }}' -- required
;

list_cells

Lists the cells for an account.

SELECT
cell_arn,
cell_name,
cells,
parent_readiness_scopes,
tags
FROM aws.route53_recovery_readiness.cells
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_cell

Creates a cell in an account.

INSERT INTO aws.route53_recovery_readiness.cells (
CellName,
Cells,
Tags,
region
)
SELECT 
'{{ CellName }}' /* required */,
'{{ Cells }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
cell_arn,
cell_name,
cells,
parent_readiness_scopes,
tags
;

Manifest

# Description fields are for documentation purposes
- name: cells
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cells resource.
  - name: CellName
    value: "{{ CellName }}"
  - name: Cells
    value:
      - "{{ Cells }}"
  - name: Tags
    value: "{{ Tags }}"
    description: |
      A collection of tags associated with a resource.

UPDATE examples

update_cell

Updates a cell to replace the list of nested cells with a new list of nested cells.

UPDATE aws.route53_recovery_readiness.cells
SET 
Cells = '{{ Cells }}'
WHERE 
cell_name = '{{ cell_name }}' --required
AND region = '{{ region }}' --required
RETURNING
cell_arn,
cell_name,
cells,
parent_readiness_scopes,
tags;

DELETE examples

delete_cell

Delete a cell. When successful, the response code is 204, with no response body.

DELETE FROM aws.route53_recovery_readiness.cells
WHERE cell_name = '{{ cell_name }}' --required
AND region = '{{ region }}' --required
;