readiness_checks

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

Overview

Name	readiness_checks
Type	Resource
Id	aws.route53_recovery_readiness.readiness_checks

Fields

The following fields are returned by SELECT queries:

get_readiness_check

Name	Datatype	Description
readiness_check_arn	string	The Amazon Resource Name (ARN) associated with a readiness check.
readiness_check_name	string	Name of a readiness check. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
resource_set	string	Name of the resource set to be checked. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
tags	object

list_readiness_checks

Name	Datatype	Description
readiness_check_arn	string	The Amazon Resource Name (ARN) associated with a readiness check.
readiness_check_name	string	Name of a readiness check. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
resource_set	string	Name of the resource set to be checked. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
tags	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_readiness_check	select	readiness_check_name, region		Gets details about a readiness check.
list_readiness_checks	select	region	maxResults, nextToken	Lists the readiness checks for an account.
create_readiness_check	insert	region, ReadinessCheckName, ResourceSetName		Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.
update_readiness_check	update	readiness_check_name, region, ResourceSetName		Updates a readiness check.
delete_readiness_check	delete	readiness_check_name, region		Deletes a readiness check.

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
readiness_check_name	string	Name of a readiness check.
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_readiness_check

Gets details about a readiness check.

SELECT
readiness_check_arn,
readiness_check_name,
resource_set,
tags
FROM aws.route53_recovery_readiness.readiness_checks
WHERE readiness_check_name = '{{ readiness_check_name }}' -- required
AND region = '{{ region }}' -- required
;

list_readiness_checks

Lists the readiness checks for an account.

SELECT
readiness_check_arn,
readiness_check_name,
resource_set,
tags
FROM aws.route53_recovery_readiness.readiness_checks
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_readiness_check

Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.

INSERT INTO aws.route53_recovery_readiness.readiness_checks (
ReadinessCheckName,
ResourceSetName,
Tags,
region
)
SELECT 
'{{ ReadinessCheckName }}' /* required */,
'{{ ResourceSetName }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
readiness_check_arn,
readiness_check_name,
resource_set,
tags
;

Manifest

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

UPDATE examples

update_readiness_check

Updates a readiness check.

UPDATE aws.route53_recovery_readiness.readiness_checks
SET 
ResourceSetName = '{{ ResourceSetName }}'
WHERE 
readiness_check_name = '{{ readiness_check_name }}' --required
AND region = '{{ region }}' --required
AND ResourceSetName = '{{ ResourceSetName }}' --required
RETURNING
readiness_check_arn,
readiness_check_name,
resource_set,
tags;

DELETE examples

delete_readiness_check

Deletes a readiness check.

DELETE FROM aws.route53_recovery_readiness.readiness_checks
WHERE readiness_check_name = '{{ readiness_check_name }}' --required
AND region = '{{ region }}' --required
;