delete-cluster¶
Description¶
Deletes a cluster. It also deletes all associated nodes and node endpoints
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
delete-cluster
--cluster-name <value>
[--final-snapshot-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--cluster-name (string)
The name of the cluster to be deleted
--final-snapshot-name (string)
The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
--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.
Output¶
Cluster -> (structure)
The cluster object that has been deleted
Name -> (string)
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description -> (string)
A description of the cluster
Status -> (string)
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates -> (structure)
A group of settings that are currently being applied.
Resharding -> (structure)
The status of an online resharding operation.
SlotMigration -> (structure)
The status of the online resharding slot migration
ProgressPercentage -> (double)
The percentage of the slot migration that is complete.
ACLs -> (structure)
A list of ACLs associated with the cluster that are being updated
ACLToApply -> (string)
A list of ACLs pending to be applied.
ServiceUpdates -> (list)
A list of service updates being applied to the cluster
(structure)
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName -> (string)
The unique ID of the service update
Status -> (string)
The status of the service update
NumberOfShards -> (integer)
The number of shards in the cluster
Shards -> (list)
A list of shards that are members of the cluster.
(structure)
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name -> (string)
The name of the shard
Status -> (string)
The current state of this replication group - creating, available, modifying, deleting.
Slots -> (string)
The keyspace for this shard.
Nodes -> (list)
A list containing information about individual nodes within the shard
(structure)
Represents an individual node within a cluster. Each node runs its own instance of the cluster’s protocol-compliant caching software.
Name -> (string)
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer’s Amazon account.
Status -> (string)
The status of the service update on the node
AvailabilityZone -> (string)
The Availability Zone in which the node resides
CreateTime -> (timestamp)
The date and time when the node was created.
Endpoint -> (structure)
The hostname for connecting to this node.
Address -> (string)
The DNS hostname of the node.
Port -> (integer)
The port number that the engine is listening on.
NumberOfNodes -> (integer)
The number of nodes in the shard
AvailabilityMode -> (string)
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint -> (structure)
The cluster’s configuration endpoint
Address -> (string)
The DNS hostname of the node.
Port -> (integer)
The port number that the engine is listening on.
NodeType -> (string)
The cluster’s node type
EngineVersion -> (string)
The Redis engine version used by the cluster
EnginePatchVersion -> (string)
The Redis engine patch version used by the cluster
ParameterGroupName -> (string)
The name of the parameter group used by the cluster
ParameterGroupStatus -> (string)
The status of the parameter group used by the cluster, for example ‘active’ or ‘applying’.
SecurityGroups -> (list)
A list of security groups used by the cluster
(structure)
Represents a single security group and its status.
SecurityGroupId -> (string)
The identifier of the security group.
Status -> (string)
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName -> (string)
The name of the subnet group used by the cluster
TLSEnabled -> (boolean)
A flag to indicate if In-transit encryption is enabled
KmsKeyId -> (string)
The ID of the KMS key used to encrypt the cluster
ARN -> (string)
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn -> (string)
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus -> (string)
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit -> (integer)
The number of days for which MemoryDB retains automatic 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.
MaintenanceWindow -> (string)
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
SnapshotWindow -> (string)
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName -> (string)
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade -> (boolean)
When set to true, the cluster will automatically receive minor engine version upgrades after launch.