resource_sets

Creates, updates, deletes or gets a resource_set resource or lists resource_sets in a region

Overview

Name	resource_sets
Type	Resource
Description	Schema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.
Id	aws.route53recoveryreadiness.resource_sets

Fields

Name	Datatype	Description
resource_set_name	string	The name of the resource set to create.
resources	array	A list of resource objects in the resource set.
resource_set_arn	string	The Amazon Resource Name (ARN) of the resource set.
resource_set_type	string	The resource type of the resources in the resource set. Enter one of the following values for resource type: AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, 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
tags	array	A tag to associate with the parameters for a resource set.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ResourceSetType, Resources, 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 resource_sets in a region.

SELECT
region,
resource_set_name,
resources,
resource_set_arn,
resource_set_type,
tags
FROM aws.route53recoveryreadiness.resource_sets
WHERE region = 'us-east-1';

Gets all properties from an individual resource_set.

SELECT
region,
resource_set_name,
resources,
resource_set_arn,
resource_set_type,
tags
FROM aws.route53recoveryreadiness.resource_sets
WHERE region = 'us-east-1' AND data__Identifier = '<ResourceSetName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.route53recoveryreadiness.resource_sets (
 Resources,
 ResourceSetType,
 region
)
SELECT 
'{{ Resources }}',
 '{{ ResourceSetType }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: resource_set
    props:
      - name: ResourceSetName
        value: '{{ ResourceSetName }}'
      - name: Resources
        value:
          - ResourceArn: '{{ ResourceArn }}'
            ComponentId: '{{ ComponentId }}'
            DnsTargetResource:
              DomainName: '{{ DomainName }}'
              RecordSetId: '{{ RecordSetId }}'
              HostedZoneArn: '{{ HostedZoneArn }}'
              RecordType: '{{ RecordType }}'
              TargetResource:
                NLBResource:
                  Arn: '{{ Arn }}'
                R53Resource:
                  DomainName: '{{ DomainName }}'
                  RecordSetId: '{{ RecordSetId }}'
            ReadinessScopes:
              - '{{ ReadinessScopes[0] }}'
      - name: ResourceSetType
        value: '{{ ResourceSetType }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

route53-recovery-readiness:CreateResourceSet,
route53-recovery-readiness:GetResourceSet,
route53-recovery-readiness:GetRecoveryGroup,
route53-recovery-readiness:GetCell,
route53-recovery-readiness:ListTagsForResources,
route53-recovery-readiness:TagResource

Read

route53-recovery-readiness:GetResourceSet,
route53-recovery-readiness:ListTagsForResources

Update

route53-recovery-readiness:UpdateResourceSet,
route53-recovery-readiness:GetResourceSet,
route53-recovery-readiness:GetRecoveryGroup,
route53-recovery-readiness:GetCell,
route53-recovery-readiness:ListTagsForResources,
route53-recovery-readiness:TagResource,
route53-recovery-readiness:UntagResource

Delete

route53-recovery-readiness:DeleteResourceSet,
route53-recovery-readiness:GetResourceSet

List

route53-recovery-readiness:ListResourceSets