[ aws . elasticache ]
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.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
delete-replication-group
--replication-group-id <value>
[--retain-primary-cluster | --no-retain-primary-cluster]
[--final-snapshot-identifier <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--replication-group-id
(string)
The identifier for the cluster to be deleted. This parameter is not case sensitive.
--retain-primary-cluster
| --no-retain-primary-cluster
(boolean)
If set to
true
, all of the read replicas are deleted, but the primary node is retained.
--final-snapshot-identifier
(string)
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.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To delete a replication group
The following delete-replication-group
example 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. Valid for Redis only.
aws elasticache delete-replication-group \
--replication-group-id "mygroup"
Output:
{
"ReplicationGroup": {
"ReplicationGroupId": "mygroup",
"Description": "my group",
"Status": "deleting",
"PendingModifiedValues": {},
"AutomaticFailover": "disabled",
"SnapshotRetentionLimit": 0,
"SnapshotWindow": "06:00-07:00",
"TransitEncryptionEnabled": false,
"AtRestEncryptionEnabled": false
}
}
ReplicationGroup -> (structure)
Contains all of the attributes of a specific Redis replication group.
ReplicationGroupId -> (string)
The identifier for the replication group.
Description -> (string)
The user supplied description of the replication group.
GlobalReplicationGroupInfo -> (structure)
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId -> (string)
The name of the Global datastore
GlobalReplicationGroupMemberRole -> (string)
The role of the replication group in a Global datastore. Can be primary or secondary.
Status -> (string)
The current state of this replication group -
creating
,available
,modifying
,deleting
,create-failed
,snapshotting
.PendingModifiedValues -> (structure)
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId -> (string)
The primary cluster ID that is applied immediately (if
--apply-immediately
was specified), or during the next maintenance window.AutomaticFailoverStatus -> (string)
Indicates the status of automatic failover for this Redis replication group.
Resharding -> (structure)
The status of an online resharding operation.
SlotMigration -> (structure)
Represents the progress of an online resharding operation.
ProgressPercentage -> (double)
The percentage of the slot migration that is complete.
AuthTokenStatus -> (string)
The auth token status
UserGroups -> (structure)
The user group being modified.
UserGroupIdsToAdd -> (list)
The ID of the user group to add.
(string)
UserGroupIdsToRemove -> (list)
The ID of the user group to remove.
(string)
LogDeliveryConfigurations -> (list)
The log delivery configurations being modified
(structure)
The log delivery configurations being modified
LogType -> (string)
Refers to slow-log .
DestinationType -> (string)
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails -> (structure)
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails -> (structure)
The configuration details of the CloudWatch Logs destination.
LogGroup -> (string)
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails -> (structure)
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream -> (string)
The name of the Kinesis Data Firehose delivery stream.
LogFormat -> (string)
Returns the log format, either JSON or TEXT
MemberClusters -> (list)
The names of all the cache clusters that are part of this replication group.
(string)
NodeGroups -> (list)
A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
(structure)
Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
NodeGroupId -> (string)
The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
Status -> (string)
The current state of this replication group -
creating
,available
,modifying
,deleting
.PrimaryEndpoint -> (structure)
The endpoint of the primary node in this node group (shard).
Address -> (string)
The DNS hostname of the cache node.
Port -> (integer)
The port number that the cache engine is listening on.
ReaderEndpoint -> (structure)
The endpoint of the replica nodes in this node group (shard).
Address -> (string)
The DNS hostname of the cache node.
Port -> (integer)
The port number that the cache engine is listening on.
Slots -> (string)
The keyspace for this node group (shard).
NodeGroupMembers -> (list)
A list containing information about individual nodes within the node group (shard).
(structure)
Represents a single node within a node group (shard).
CacheClusterId -> (string)
The ID of the cluster to which the node belongs.
CacheNodeId -> (string)
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint -> (structure)
The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
Address -> (string)
The DNS hostname of the cache node.
Port -> (integer)
The port number that the cache engine is listening on.
PreferredAvailabilityZone -> (string)
The name of the Availability Zone in which the node is located.
PreferredOutpostArn -> (string)
The outpost ARN of the node group member.
CurrentRole -> (string)
The role that is currently assigned to the node -
primary
orreplica
. This member is only applicable for Redis (cluster mode disabled) replication groups.SnapshottingClusterId -> (string)
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover -> (string)
Indicates the status of automatic failover for this Redis replication group.
MultiAZ -> (string)
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint -> (structure)
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address -> (string)
The DNS hostname of the cache node.
Port -> (integer)
The port number that the cache engine is listening on.
SnapshotRetentionLimit -> (integer)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set
SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being deleted.Warning
If the value of
SnapshotRetentionLimit
is set to zero (0), backups are turned off.SnapshotWindow -> (string)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example:
05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
Note
This parameter is only valid if the
Engine
parameter isredis
.ClusterEnabled -> (boolean)
A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
Valid values:
true
|false
CacheNodeType -> (string)
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled -> (boolean)
A flag that enables using an
AuthToken
(password) when issuing Redis commands.Default:
false
AuthTokenLastModifiedDate -> (timestamp)
The date the auth token was last modified
TransitEncryptionEnabled -> (boolean)
A flag that enables in-transit encryption when set to
true
.You cannot modify the value of
TransitEncryptionEnabled
after the cluster is created. To enable in-transit encryption on a cluster you must setTransitEncryptionEnabled
totrue
when you create a cluster.Required: Only available when creating a replication group in an Amazon VPC using redis version
3.2.6
,4.x
or later.Default:
false
AtRestEncryptionEnabled -> (boolean)
A flag that enables encryption at-rest when set to
true
.You cannot modify the value of
AtRestEncryptionEnabled
after the cluster is created. To enable encryption at-rest on a cluster you must setAtRestEncryptionEnabled
totrue
when you create a cluster.Required: Only available when creating a replication group in an Amazon VPC using redis version
3.2.6
,4.x
or later.Default:
false
MemberClustersOutpostArns -> (list)
The outpost ARNs of the replication group’s member clusters.
(string)
KmsKeyId -> (string)
The ID of the KMS key used to encrypt the disk in the cluster.
ARN -> (string)
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds -> (list)
The ID of the user group associated to the replication group.
(string)
LogDeliveryConfigurations -> (list)
Returns the destination, format and type of the logs.
(structure)
Returns the destination, format and type of the logs.
LogType -> (string)
Refers to slow-log .
DestinationType -> (string)
Returns the destination type, either
cloudwatch-logs
orkinesis-firehose
.DestinationDetails -> (structure)
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails -> (structure)
The configuration details of the CloudWatch Logs destination.
LogGroup -> (string)
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails -> (structure)
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream -> (string)
The name of the Kinesis Data Firehose delivery stream.
LogFormat -> (string)
Returns the log format, either JSON or TEXT.
Status -> (string)
Returns the log delivery configuration status. Values are one of
enabling
|disabling
|modifying
|active
|error
Message -> (string)
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime -> (timestamp)
The date and time when the cluster was created.