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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
recovery_group_name	string	The name of the recovery group to create.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual recovery_group.

SELECT
  region,
  recovery_group_name,
  cells,
  recovery_group_arn,
  tags
FROM awscc.route53recoveryreadiness.recovery_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ recovery_group_name }}';

list (identifiers only)

Lists all recovery_groups in a region.

SELECT
  region,
  recovery_group_name
FROM awscc.route53recoveryreadiness.recovery_groups_list_only
WHERE
  region = 'us-east-1';

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 awscc.route53recoveryreadiness.recovery_groups (
  RecoveryGroupName,
  Cells,
  Tags,
  region
)
SELECT
  '{{ recovery_group_name }}',
  '{{ cells }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.route53recoveryreadiness.recovery_groups (
  RecoveryGroupName,
  Cells,
  Tags,
  region
)
SELECT
  '{{ recovery_group_name }}',
  '{{ 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: recovery_group_name
        value: '{{ recovery_group_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 recovery_group resource, using stack-deploy.

/*+ update */
UPDATE awscc.route53recoveryreadiness.recovery_groups
SET PatchDocument = string('{{ {
    "Cells": cells,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ recovery_group_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.route53recoveryreadiness.recovery_groups
WHERE
  Identifier = '{{ recovery_group_name }}' 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