DeleteGlobalCluster - Amazon DocumentDB
Request ParametersResponse ElementsErrorsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

DeleteGlobalCluster

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

Note

This action only applies to Amazon DocumentDB clusters.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

GlobalClusterIdentifier

The cluster identifier of the global cluster being deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Required: Yes

Response Elements

The following element is returned by the service.

GlobalCluster

A data type representing an Amazon DocumentDB global cluster.

Type: GlobalCluster object

Errors

For information about the errors that are common to all actions, see Common Errors.

GlobalClusterNotFoundFault

The GlobalClusterIdentifier doesn't refer to an existing global cluster.

HTTP Status Code: 404

InvalidGlobalClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

See Also

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