Skip to content

/AWS1/CL_ECA=>DELETECACHECLUSTER()

About DeleteCacheCluster

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

  • Valkey or Redis OSS (cluster mode enabled) clusters

  • Valkey or Redis OSS (cluster mode disabled) clusters

  • A cluster that is the last read replica of a replication group

  • A cluster that is the primary node of a replication group

  • A node group (shard) that has Multi-AZ mode enabled

  • A cluster from a Valkey or Redis OSS (cluster mode enabled) replication group

  • A cluster that is not in the available state

Method Signature

IMPORTING

Required arguments:

IV_CACHECLUSTERID TYPE /AWS1/ECASTRING /AWS1/ECASTRING

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

Optional arguments:

IV_FINALSNAPSHOTIDENTIFIER TYPE /AWS1/ECASTRING /AWS1/ECASTRING

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_ECADELCACHECLUSTRSLT /AWS1/CL_ECADELCACHECLUSTRSLT