DescribeCluster, DeleteCluster - Amazon Route 53 Application Recovery Controller

DescribeCluster, DeleteCluster

URI

/cluster/ClusterArn

HTTP methods

GET

Operation ID: DescribeCluster

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

Path parameters
Name Type Required Description
ClusterArn String True

The Amazon Resource Name (ARN) of the cluster.

Responses
Status code Response model Description
200 DescribeClusterResponse

200 response - Success.

400 ValidationException

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.

403 AccessDeniedException

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

404 ResourceNotFoundException

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

409 ConflictException

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

429 ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500 InternalServerException

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

DELETE

Operation ID: DeleteCluster

Delete a cluster.

Path parameters
Name Type Required Description
ClusterArn String True

The Amazon Resource Name (ARN) of the cluster that you're deleting.

Responses
Status code Response model Description
200 DeleteClusterResponse

200 response - Success.

400 ValidationException

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.

403 AccessDeniedException

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

404 ResourceNotFoundException

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

409 ConflictException

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

429 ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500 InternalServerException

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

OPTIONS

Responses
Status code Response model Description
200 None

200 response - Success.

Schemas

Response bodies

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

Properties

AccessDeniedException

Property Type Required Description
message

string

True

Cluster

Property Type Required Description
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 Cluster (Data Plane) 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.

Property Type Required Description
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 Cluster (Data Plane) Actions.

Region

string

MinLength: 1

MaxLength: 32

False

The AWS Region for a cluster endpoint.

ConflictException

Property Type Required Description
message

string

True

DeleteClusterResponse

A successful DeleteCluster request returns no response.

DescribeClusterResponse

The result of a successful DescribeCluster request.

Property Type Required Description
Cluster

Cluster

True

The cluster for the DescribeCluster request.

InternalServerException

Property Type Required Description
message

string

True

ResourceNotFoundException

Property Type Required Description
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

ThrottlingException

Property Type Required Description
message

string

True

ValidationException

Property Type Required Description
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:

DescribeCluster

DeleteCluster