DeleteGlobalReplicationGroup - Amazon ElastiCache

DeleteGlobalReplicationGroup

Deleting a Global Datastore is a two-step process:

  • First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global Datastore.

  • Once the Global Datastore contains only the primary cluster, you can use DeleteGlobalReplicationGroup API to delete the Global Datastore while retainining the primary cluster using Retain…= true.

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryCluster=true.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

Request Parameters

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

GlobalReplicationGroupId

The name of the Global Datastore

Type: String

Required: Yes

RetainPrimaryReplicationGroup

The primary replication group is retained as a standalone replication group.

Type: Boolean

Required: Yes

Response Elements

The following element is returned by the service.

GlobalReplicationGroup

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

  • The GlobalReplicationGroupIdSuffix represents the name of the Global Datastore, which is what you use to associate a secondary cluster.

Type: GlobalReplicationGroup object

Errors

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

GlobalReplicationGroupNotFoundFault

The Global Datastore does not exist

HTTP Status Code: 404

InvalidGlobalReplicationGroupState

The Global Datastore is not available or in primary-only state.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

See Also

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