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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
readiness_check_name	string	Name of the ReadinessCheck to create.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual readiness_check.

SELECT
  region,
  resource_set_name,
  readiness_check_name,
  readiness_check_arn,
  tags
FROM awscc.route53recoveryreadiness.readiness_checks
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ readiness_check_name }}';

list (identifiers only)

Lists all readiness_checks in a region.

SELECT
  region,
  readiness_check_name
FROM awscc.route53recoveryreadiness.readiness_checks_list_only
WHERE
  region = '{{ region }}';

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 awscc.route53recoveryreadiness.readiness_checks (
  ResourceSetName,
  ReadinessCheckName,
  Tags,
  region
)
SELECT
  '{{ resource_set_name }}',
  '{{ readiness_check_name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.route53recoveryreadiness.readiness_checks (
  ResourceSetName,
  ReadinessCheckName,
  Tags,
  region
)
SELECT
  '{{ resource_set_name }}',
  '{{ readiness_check_name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: readiness_check
  props:
    - name: resource_set_name
      value: '{{ resource_set_name }}'
    - name: readiness_check_name
      value: '{{ readiness_check_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.route53recoveryreadiness.readiness_checks
SET PatchDocument = string('{{ {
    "ResourceSetName": resource_set_name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ readiness_check_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.route53recoveryreadiness.readiness_checks
WHERE
  Identifier = '{{ readiness_check_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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