readiness_checks

Creates, updates, deletes or gets a readiness_check resource or lists readiness_checks in a region

Overview

Name	readiness_checks
Type	Resource
Description	Aws Route53 Recovery Readiness Check Schema and API specification.
Id	aws.route53recoveryreadiness.readiness_checks

Fields

Name	Datatype	Description
resource_set_name	string	The name of the resource set to check.
readiness_check_name	string	Name of the ReadinessCheck to create.
readiness_check_arn	string	The Amazon Resource Name (ARN) of the readiness check.
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 readiness_checks in a region.

SELECT
region,
resource_set_name,
readiness_check_name,
readiness_check_arn,
tags
FROM aws.route53recoveryreadiness.readiness_checks
WHERE region = 'us-east-1';

Gets all properties from an individual readiness_check.

SELECT
region,
resource_set_name,
readiness_check_name,
readiness_check_arn,
tags
FROM aws.route53recoveryreadiness.readiness_checks
WHERE region = 'us-east-1' AND data__Identifier = '<ReadinessCheckName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.route53recoveryreadiness.readiness_checks (
 ResourceSetName,
 ReadinessCheckName,
 Tags,
 region
)
SELECT 
'{{ ResourceSetName }}',
 '{{ ReadinessCheckName }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.route53recoveryreadiness.readiness_checks (
 ResourceSetName,
 ReadinessCheckName,
 Tags,
 region
)
SELECT 
 '{{ ResourceSetName }}',
 '{{ ReadinessCheckName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: readiness_check
    props:
      - name: ResourceSetName
        value: '{{ ResourceSetName }}'
      - name: ReadinessCheckName
        value: '{{ ReadinessCheckName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

route53-recovery-readiness:CreateReadinessCheck,
route53-recovery-readiness:GetResourceSet,
route53-recovery-readiness:GetReadinessCheck,
route53-recovery-readiness:ListTagsForResources,
route53-recovery-readiness:TagResource

Read

route53-recovery-readiness:GetReadinessCheck,
route53-recovery-readiness:ListTagsForResources

Update

route53-recovery-readiness:UpdateReadinessCheck,
route53-recovery-readiness:GetResourceSet,
route53-recovery-readiness:GetReadinessCheck,
route53-recovery-readiness:ListTagsForResources,
route53-recovery-readiness:TagResource,
route53-recovery-readiness:UntagResource

Delete

route53-recovery-readiness:DeleteReadinessCheck,
route53-recovery-readiness:GetReadinessCheck

List

route53-recovery-readiness:ListReadinessChecks,
route53-recovery-readiness:GetReadinessChecks