delete-cluster¶
Description¶
Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
delete-cluster
--cluster-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--cluster-name (string)
The name of the cluster to be 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.
Examples¶
To delete a DAX cluster
The following delete-cluster example deletes the specified DAX cluster.
aws dax delete-cluster \
--cluster-name daxcluster
Output:
{
"Cluster": {
"ClusterName": "daxcluster",
"ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
"TotalNodes": 3,
"ActiveNodes": 0,
"NodeType": "dax.r4.large",
"Status": "deleting",
"ClusterDiscoveryEndpoint": {
"Address": "dd.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"PreferredMaintenanceWindow": "fri:06:00-fri:07:00",
"SubnetGroup": "default",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "sg-1af6e36e",
"Status": "active"
}
],
"IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
"ParameterGroup": {
"ParameterGroupName": "default.dax1.0",
"ParameterApplyStatus": "in-sync",
"NodeIdsToReboot": []
},
"SSEDescription": {
"Status": "ENABLED"
}
}
}
For more information, see Managing DAX Clusters in the Amazon DynamoDB Developer Guide.
Output¶
Cluster -> (structure)
A description of the DAX cluster that is being deleted.
ClusterName -> (string)
The name of the DAX cluster.
Description -> (string)
The description of the cluster.
ClusterArn -> (string)
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TotalNodes -> (integer)
The total number of nodes in the cluster.
ActiveNodes -> (integer)
The number of nodes in the cluster that are active (i.e., capable of serving requests).
NodeType -> (string)
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Status -> (string)
The current status of the cluster.
ClusterDiscoveryEndpoint -> (structure)
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address -> (string)
The DNS hostname of the endpoint.
Port -> (integer)
The port number that applications should use to connect to the endpoint.
NodeIdsToRemove -> (list)
A list of nodes to be removed from the cluster.
(string)
Nodes -> (list)
A list of nodes that are currently in the cluster.
(structure)
Represents an individual node within a DAX cluster.
NodeId -> (string)
A system-generated identifier for the node.
Endpoint -> (structure)
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address -> (string)
The DNS hostname of the endpoint.
Port -> (integer)
The port number that applications should use to connect to the endpoint.
NodeCreateTime -> (timestamp)
The date and time (in UNIX epoch format) when the node was launched.
AvailabilityZone -> (string)
The Availability Zone (AZ) in which the node has been deployed.
NodeStatus -> (string)
The current status of the node. For example:
available.ParameterGroupStatus -> (string)
The status of the parameter group associated with this node. For example,
in-sync.PreferredMaintenanceWindow -> (string)
A range of time when maintenance of DAX cluster software will be performed. For example:
sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.NotificationConfiguration -> (structure)
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn -> (string)
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus -> (string)
The current state of the topic.
SubnetGroup -> (string)
The subnet group where the DAX cluster is running.
SecurityGroups -> (list)
A list of security groups, and the status of each, for the nodes in the cluster.
(structure)
An individual VPC security group and its status.
SecurityGroupIdentifier -> (string)
The unique ID for this security group.
Status -> (string)
The status of this security group.
IamRoleArn -> (string)
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role’s permissions to access DynamoDB on your behalf.
ParameterGroup -> (structure)
The parameter group being used by nodes in the cluster.
ParameterGroupName -> (string)
The name of the parameter group.
ParameterApplyStatus -> (string)
The status of parameter updates.
NodeIdsToReboot -> (list)
The node IDs of one or more nodes to be rebooted.
(string)
SSEDescription -> (structure)
The description of the server-side encryption status on the specified DAX cluster.
Status -> (string)
The current state of server-side encryption:
ENABLING- Server-side encryption is being enabled.
ENABLED- Server-side encryption is enabled.
DISABLING- Server-side encryption is being disabled.
DISABLED- Server-side encryption is disabled.