DeleteMultiRegionCluster - Amazon MemoryDB

DeleteMultiRegionCluster

Deletes an existing multi-Region cluster.

Request Syntax

{ "MultiRegionClusterName": "string" }

Request Parameters

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

The request accepts the following data in JSON format.

MultiRegionClusterName

The name of the multi-Region cluster to be deleted.

Type: String

Required: Yes

Response Syntax

{ "MultiRegionCluster": { "ARN": "string", "Clusters": [ { "ARN": "string", "ClusterName": "string", "Region": "string", "Status": "string" } ], "Description": "string", "Engine": "string", "EngineVersion": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "string", "NodeType": "string", "NumberOfShards": number, "Status": "string", "TLSEnabled": boolean } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MultiRegionCluster

Details about the deleted multi-Region cluster.

Type: MultiRegionCluster object

Errors

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

InvalidMultiRegionClusterStateFault

The requested operation cannot be performed on the multi-Region cluster in its current state.

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

MultiRegionClusterNotFoundFault

The specified multi-Region cluster does not exist.

HTTP Status Code: 400

See Also

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