resource_sets

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

Overview

Name	resource_sets
Type	Resource
Id	aws.route53_recovery_readiness.resource_sets

Fields

The following fields are returned by SELECT queries:

get_resource_set

Name	Datatype	Description
resource_set_arn	string	The Amazon Resource Name (ARN) for the resource set.
resource_set_name	string	The name of the resource set. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
resource_set_type	string	The resource type of the resources in the resource set. Enter one of the following values for resource type: AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource (pattern: <code>AWS::[A-Za-z0-9]+::[A-Za-z0-9]+</code>)
resources	array	A list of resource objects.
tags	object

list_resource_sets

Name	Datatype	Description
resource_set_arn	string	The Amazon Resource Name (ARN) for the resource set.
resource_set_name	string	The name of the resource set. (pattern: <code>\A[a-zA-Z0-9_]+\z</code>)
resource_set_type	string	The resource type of the resources in the resource set. Enter one of the following values for resource type: AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource (pattern: <code>AWS::[A-Za-z0-9]+::[A-Za-z0-9]+</code>)
resources	array	A list of resource objects.
tags	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_set	select	resource_set_name, region		Displays the details about a resource set, including a list of the resources in the set.
list_resource_sets	select	region	maxResults, nextToken	Lists the resource sets in an account.
create_resource_set	insert	region, ResourceSetName, ResourceSetType		Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.
update_resource_set	update	resource_set_name, region, ResourceSetType		Updates a resource set.
delete_resource_set	delete	resource_set_name, region		Deletes a resource set.

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
region	string	AWS region (default: us-east-1)
resource_set_name	string	Name of a resource set.
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_resource_set

Displays the details about a resource set, including a list of the resources in the set.

SELECT
resource_set_arn,
resource_set_name,
resource_set_type,
resources,
tags
FROM aws.route53_recovery_readiness.resource_sets
WHERE resource_set_name = '{{ resource_set_name }}' -- required
AND region = '{{ region }}' -- required
;

list_resource_sets

Lists the resource sets in an account.

SELECT
resource_set_arn,
resource_set_name,
resource_set_type,
resources,
tags
FROM aws.route53_recovery_readiness.resource_sets
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_resource_set

Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.

INSERT INTO aws.route53_recovery_readiness.resource_sets (
ResourceSetName,
ResourceSetType,
Resources,
Tags,
region
)
SELECT 
'{{ ResourceSetName }}' /* required */,
'{{ ResourceSetType }}' /* required */,
'{{ Resources }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
resource_set_arn,
resource_set_name,
resource_set_type,
resources,
tags
;

Manifest

# Description fields are for documentation purposes
- name: resource_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the resource_sets resource.
  - name: ResourceSetName
    value: "{{ ResourceSetName }}"
  - name: ResourceSetType
    value: "{{ ResourceSetType }}"
  - name: Resources
    value:
      - ComponentId: "{{ ComponentId }}"
        DnsTargetResource:
          DomainName: "{{ DomainName }}"
          HostedZoneArn: "{{ HostedZoneArn }}"
          RecordSetId: "{{ RecordSetId }}"
          RecordType: "{{ RecordType }}"
          TargetResource:
            NLBResource:
              Arn: "{{ Arn }}"
            R53Resource:
              DomainName: "{{ DomainName }}"
              RecordSetId: "{{ RecordSetId }}"
        ReadinessScopes: "{{ ReadinessScopes }}"
        ResourceArn: "{{ ResourceArn }}"
  - name: Tags
    value: "{{ Tags }}"
    description: |
      A collection of tags associated with a resource.

UPDATE examples

update_resource_set

Updates a resource set.

UPDATE aws.route53_recovery_readiness.resource_sets
SET 
ResourceSetType = '{{ ResourceSetType }}',
Resources = '{{ Resources }}'
WHERE 
resource_set_name = '{{ resource_set_name }}' --required
AND region = '{{ region }}' --required
AND ResourceSetType = '{{ ResourceSetType }}' --required
RETURNING
resource_set_arn,
resource_set_name,
resource_set_type,
resources,
tags;

DELETE examples

delete_resource_set

Deletes a resource set.

DELETE FROM aws.route53_recovery_readiness.resource_sets
WHERE resource_set_name = '{{ resource_set_name }}' --required
AND region = '{{ region }}' --required
;