Skip to content

/AWS1/CL_ECA=>DELETEREPLICATIONGROUP()

About DeleteReplicationGroup

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, 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.

This operation is valid for Redis only.

Method Signature

IMPORTING

Required arguments:

IV_REPLICATIONGROUPID TYPE /AWS1/ECASTRING /AWS1/ECASTRING

The identifier for the cluster to be deleted. This parameter is not case sensitive.

Optional arguments:

IV_RETAINPRIMARYCLUSTER TYPE /AWS1/ECABOOLEANOPTIONAL /AWS1/ECABOOLEANOPTIONAL

If set to true, all of the read replicas are deleted, but the primary node is retained.

IV_FINALSNAPSHOTIDENTIFIER TYPE /AWS1/ECASTRING /AWS1/ECASTRING

The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_ECADELREPLGROUPRSLT /AWS1/CL_ECADELREPLGROUPRSLT