recovery_groups

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

Overview

Name	recovery_groups
Type	Resource
Id	aws.route53_recovery_readiness.recovery_groups

Fields

The following fields are returned by SELECT queries:

get_recovery_group

Name	Datatype	Description
cells	array	A list of a cell's Amazon Resource Names (ARNs).
recovery_group_arn	string	The Amazon Resource Name (ARN) for the recovery group.
recovery_group_name	string	The name of the recovery group. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
tags	object	The tags associated with the recovery group.

list_recovery_groups

Name	Datatype	Description
cells	array	A list of a cell's Amazon Resource Names (ARNs).
recovery_group_arn	string	The Amazon Resource Name (ARN) for the recovery group.
recovery_group_name	string	The name of the recovery group. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
tags	object	The tags associated with the recovery group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recovery_group	select	recovery_group_name, region		Gets details about a recovery group, including a list of the cells that are included in it.
list_recovery_groups	select	region	maxResults, nextToken	Lists the recovery groups in an account.
create_recovery_group	insert	region, RecoveryGroupName		Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.
update_recovery_group	update	recovery_group_name, region		Updates a recovery group.
delete_recovery_group	delete	recovery_group_name, region		Deletes a recovery group.

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
recovery_group_name	string	The name of a recovery group.
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_recovery_group

Gets details about a recovery group, including a list of the cells that are included in it.

SELECT
cells,
recovery_group_arn,
recovery_group_name,
tags
FROM aws.route53_recovery_readiness.recovery_groups
WHERE recovery_group_name = '{{ recovery_group_name }}' -- required
AND region = '{{ region }}' -- required
;

list_recovery_groups

Lists the recovery groups in an account.

SELECT
cells,
recovery_group_arn,
recovery_group_name,
tags
FROM aws.route53_recovery_readiness.recovery_groups
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_recovery_group

Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.

INSERT INTO aws.route53_recovery_readiness.recovery_groups (
Cells,
RecoveryGroupName,
Tags,
region
)
SELECT 
'{{ Cells }}',
'{{ RecoveryGroupName }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
cells,
recovery_group_arn,
recovery_group_name,
tags
;

Manifest

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

UPDATE examples

update_recovery_group

Updates a recovery group.

UPDATE aws.route53_recovery_readiness.recovery_groups
SET 
Cells = '{{ Cells }}'
WHERE 
recovery_group_name = '{{ recovery_group_name }}' --required
AND region = '{{ region }}' --required
RETURNING
cells,
recovery_group_arn,
recovery_group_name,
tags;

DELETE examples

delete_recovery_group

Deletes a recovery group.

DELETE FROM aws.route53_recovery_readiness.recovery_groups
WHERE recovery_group_name = '{{ recovery_group_name }}' --required
AND region = '{{ region }}' --required
;