clusters

Creates, updates, deletes or gets a cluster resource or lists clusters in a region

Overview

Name	clusters
Type	Resource
Description	AWS Route53 Recovery Control Cluster resource schema
Id	aws.route53recoverycontrol.clusters

Fields

Name	Datatype	Description
name	string	Name of a Cluster. You can use any non-white space character in the name
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster.
status	string	Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
cluster_endpoints	array	Endpoints for the cluster.
tags	array	A collection of tags associated with a resource
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all clusters in a region.

SELECT
region,
name,
cluster_arn,
status,
cluster_endpoints,
tags
FROM aws.route53recoverycontrol.clusters
WHERE region = 'us-east-1';

Gets all properties from an individual cluster.

SELECT
region,
name,
cluster_arn,
status,
cluster_endpoints,
tags
FROM aws.route53recoverycontrol.clusters
WHERE region = 'us-east-1' AND data__Identifier = '<ClusterArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.route53recoverycontrol.clusters (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.route53recoverycontrol.clusters (
 Name,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

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

DELETE example

/*+ delete */
DELETE FROM aws.route53recoverycontrol.clusters
WHERE data__Identifier = '<ClusterArn>'
AND region = 'us-east-1';

Permissions

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

Create

route53-recovery-control-config:CreateCluster,
route53-recovery-control-config:DescribeCluster,
route53-recovery-control-config:ListTagsForResource,
route53-recovery-control-config:TagResource

Read

route53-recovery-control-config:DescribeCluster,
route53-recovery-control-config:ListTagsForResource

Delete

route53-recovery-control-config:DescribeCluster,
route53-recovery-control-config:DeleteCluster

List

route53-recovery-control-config:ListClusters