ListClusters, CreateCluster - Amazon Route 53 Application Recovery Controller

ListClusters, CreateCluster

URI

/cluster

HTTP methods

GET

Operation ID: ListClusters

Returns an array of all the clusters in an account.

Query parameters
NameTypeRequiredDescription
MaxResultsStringFalse

The number of objects that you want to return with this call.

NextTokenStringFalse

The token that identifies which batch of results you want to see.

Responses
Status codeResponse modelDescription
200ListClustersResponse

200 response - Success.

400ValidationException

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

403AccessDeniedException

403 response - AccessDeniedException. You do not have sufficient access to perform this action.

404ResourceNotFoundException

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

429ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500InternalServerException

500 response - InternalServiceError. Temporary service error. Retry the request.

POST

Operation ID: CreateCluster

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 AWS Region) that you can use with API calls to the cluster data plane.

Responses
Status codeResponse modelDescription
200CreateClusterResponse

200 response - Success.

400ValidationException

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

402ServiceQuotaExceededException

402 response

403AccessDeniedException

403 response - AccessDeniedException. You do not have sufficient access to perform this action.

404ResourceNotFoundException

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

409ConflictException

409 response - ConflictException. You might be using a predefined variable.

429ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500InternalServerException

500 response - InternalServiceError. Temporary service error. Retry the request.

OPTIONS

Responses
Status codeResponse modelDescription
200None

200 response - Success.

Schemas

Request bodies

{ "ClusterName": "string", "ClientToken": "string", "Tags": [ { "Value": "string", "Key": "string" } ] }

Response bodies

{ "NextToken": "string", "Clusters": [ { "ClusterArn": "string", "Status": enum, "ClusterEndpoints": [ { "Endpoint": "string", "Region": "string" } ], "Name": "string" } ] }
{ "Cluster": { "ClusterArn": "string", "Status": enum, "ClusterEndpoints": [ { "Endpoint": "string", "Region": "string" } ], "Name": "string" } }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }

Properties

AccessDeniedException

403 response - You do not have sufficient access to perform this action.

PropertyTypeRequiredDescription
message

string

True

Cluster

A set of five redundant Regional endpoints against which you can execute API calls to update or get the state of routing controls. You can host multiple control panels and routing controls on one cluster.

PropertyTypeRequiredDescription
ClusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

ClusterEndpoints

Array of type ClusterEndpoint

False

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

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

False

The name of the cluster.

Status

Status

False

Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

ClusterEndpoint

A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.

PropertyTypeRequiredDescription
Endpoint

string

MinLength: 1

MaxLength: 128

False

A cluster endpoint. Specify an endpoint and AWS Region 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.

Region

string

MinLength: 1

MaxLength: 32

False

The AWS Region for a cluster endpoint.

ConflictException

409 response - ConflictException. You might be using a predefined variable.

PropertyTypeRequiredDescription
message

string

True

CreateClusterRequest

The properties of a request to create a cluster.

PropertyTypeRequiredDescription
ClientToken

string

MaxLength: 64

False

A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

ClusterName

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

True

The name of the cluster.

Tags

Array of type Tag

False

The tags associated with the cluster.

CreateClusterResponse

The result of a successful CreateCluster request.

PropertyTypeRequiredDescription
Cluster

Cluster

True

The cluster that was created.

InternalServerException

500 response - InternalServiceError. Temporary service error. Retry the request.

PropertyTypeRequiredDescription
message

string

True

ListClustersResponse

The result of a successful ListClusters request.

PropertyTypeRequiredDescription
Clusters

Array of type Cluster

False

An array of the clusters in an account.

NextToken

string

MaxLength: 8096

False

The token that identifies which batch of results you want to see.

ResourceNotFoundException

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

PropertyTypeRequiredDescription
message

string

True

ServiceQuotaExceededException

402 response - You attempted to create more resources than the service allows based on service quotas.

PropertyTypeRequiredDescription
message

string

True

Status

The deployment status of a resource. Status can be one of the following:

PENDING: Amazon Route 53 Application Recovery Controller is creating the resource.

DEPLOYED: The resource is deployed and ready to use.

PENDING_DELETION: Amazon Route 53 Application Recovery Controller is deleting the resource.

  • PENDING

  • DEPLOYED

  • PENDING_DELETION

Tag

A tag that you add to a resource.

PropertyTypeRequiredDescription
Key

string

MinLength: 1

MaxLength: 128

True

The key for a tag.

Value

string

MaxLength: 256

True

The value for a tag.

ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

PropertyTypeRequiredDescription
message

string

True

ValidationException

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

PropertyTypeRequiredDescription
message

string

True

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListClusters

CreateCluster