recovery_groups

Creates, updates, deletes or gets a recovery_group resource or lists recovery_groups in a region

Overview

Name	recovery_groups
Type	Resource
Description	AWS Route53 Recovery Readiness Recovery Group Schema and API specifications.
Id	aws.route53recoveryreadiness.recovery_groups

Fields

Name	Datatype	Description
recovery_group_name	string	The name of the recovery group to create.
cells	array	A list of the cell Amazon Resource Names (ARNs) in the recovery group.
recovery_group_arn	string	A collection of tags associated with a resource.
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 recovery_groups in a region.

SELECT
region,
recovery_group_name,
cells,
recovery_group_arn,
tags
FROM aws.route53recoveryreadiness.recovery_groups
WHERE region = 'us-east-1';

Gets all properties from an individual recovery_group.

SELECT
region,
recovery_group_name,
cells,
recovery_group_arn,
tags
FROM aws.route53recoveryreadiness.recovery_groups
WHERE region = 'us-east-1' AND data__Identifier = '<RecoveryGroupName>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

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

DELETE example

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

Permissions

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

Create

route53-recovery-readiness:CreateRecoveryGroup,
route53-recovery-readiness:GetRecoveryGroup,
route53-recovery-readiness:GetCell,
route53-recovery-readiness:ListTagsForResources,
route53-recovery-readiness:TagResource

Read

route53-recovery-readiness:GetRecoveryGroup,
route53-recovery-readiness:ListTagsForResources

Update

route53-recovery-readiness:UpdateRecoveryGroup,
route53-recovery-readiness:GetRecoveryGroup,
route53-recovery-readiness:GetCell,
route53-recovery-readiness:ListTagsForResources,
route53-recovery-readiness:TagResource,
route53-recovery-readiness:UntagResource

Delete

route53-recovery-readiness:DeleteRecoveryGroup,
route53-recovery-readiness:GetRecoveryGroup

List

route53-recovery-readiness:ListRecoveryGroups