clusters

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

Overview

Name	clusters
Type	Resource
Id	aws.route53_recovery_control_config.clusters

Fields

The following fields are returned by SELECT queries:

describe_cluster

Name	Datatype	Description
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
cluster_endpoints	array	Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster. To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.
name	string	The name of the cluster. (pattern: <code>^\S+$</code>)
network_type	string	The network type of a cluster. NetworkType can be one of the following: IPV4: Cluster endpoints support IPv4 only. DUALSTACK: Cluster endpoints support both IPv4 and IPv6. (IPV4, DUALSTACK)
owner	string	The Amazon Web Services account ID of the cluster owner. (pattern: <code>^\d{12}$</code>)
status	string	Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION. (PENDING, DEPLOYED, PENDING_DELETION)

list_clusters

Name	Datatype	Description
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
cluster_endpoints	array	Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster. To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.
name	string	The name of the cluster. (pattern: <code>^\S+$</code>)
network_type	string	The network type of a cluster. NetworkType can be one of the following: IPV4: Cluster endpoints support IPv4 only. DUALSTACK: Cluster endpoints support both IPv4 and IPv6. (IPV4, DUALSTACK)
owner	string	The Amazon Web Services account ID of the cluster owner. (pattern: <code>^\d{12}$</code>)
status	string	Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION. (PENDING, DEPLOYED, PENDING_DELETION)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cluster	select	cluster_arn, region		Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
list_clusters	select	region	MaxResults, NextToken	Returns an array of all the clusters in an account.
create_cluster	insert	region, ClusterName		Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.
update_cluster	update	region, ClusterArn, NetworkType		Updates an existing cluster. You can only update the network type of a cluster.
delete_cluster	delete	cluster_arn, region		Delete a cluster.

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
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster that you're deleting.
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

describe_cluster

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

SELECT
cluster_arn,
cluster_endpoints,
name,
network_type,
owner,
status
FROM aws.route53_recovery_control_config.clusters
WHERE cluster_arn = '{{ cluster_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_clusters

Returns an array of all the clusters in an account.

SELECT
cluster_arn,
cluster_endpoints,
name,
network_type,
owner,
status
FROM aws.route53_recovery_control_config.clusters
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_cluster

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.

INSERT INTO aws.route53_recovery_control_config.clusters (
ClientToken,
ClusterName,
Tags,
NetworkType,
region
)
SELECT 
'{{ ClientToken }}',
'{{ ClusterName }}' /* required */,
'{{ Tags }}',
'{{ NetworkType }}',
'{{ region }}'
RETURNING
cluster
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the clusters resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: ClusterName
    value: "{{ ClusterName }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: NetworkType
    value: "{{ NetworkType }}"
    description: |
      The network type of a cluster. NetworkType can be one of the following: IPV4: Cluster endpoints support IPv4 only. DUALSTACK: Cluster endpoints support both IPv4 and IPv6.
    valid_values: ['IPV4', 'DUALSTACK']

UPDATE examples

update_cluster

Updates an existing cluster. You can only update the network type of a cluster.

UPDATE aws.route53_recovery_control_config.clusters
SET 
ClusterArn = '{{ ClusterArn }}',
NetworkType = '{{ NetworkType }}'
WHERE 
region = '{{ region }}' --required
AND ClusterArn = '{{ ClusterArn }}' --required
AND NetworkType = '{{ NetworkType }}' --required
RETURNING
cluster;

DELETE examples

delete_cluster

Delete a cluster.

DELETE FROM aws.route53_recovery_control_config.clusters
WHERE cluster_arn = '{{ cluster_arn }}' --required
AND region = '{{ region }}' --required
;