---
title: "POST /#X-Amz-Target=AmazonDAXV3.DeleteCluster"
method: POST
path: "/#X-Amz-Target=AmazonDAXV3.DeleteCluster"
---

# POST /#X-Amz-Target=AmazonDAXV3.DeleteCluster

`POST /#X-Amz-Target=AmazonDAXV3.DeleteCluster`

Deletes a previously provisioned DAX cluster. <i>DeleteCluster</i> 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.

## Headers

- `X-Amz-Target` 'AmazonDAXV3.DeleteCluster', required

## Request body

- DeleteClusterRequest
  - `ClusterName` string, required — The name of the cluster to be deleted.

## Response `200`

Success

- DeleteClusterResponse
  - `Cluster` object — 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` object — The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.
      - `Address` string — The DNS hostname of the endpoint.
      - `Port` integer — The port number that applications should use to connect to the endpoint.
      - `URL` string — The URL that applications should use to connect to the endpoint. The default ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.
    - `NodeIdsToRemove` String[] — A list of nodes to be removed from the cluster.
    - `Nodes` Node[] — A list of nodes that are currently in the cluster.
      - `NodeId` string — A system-generated identifier for the node.
      - `Endpoint` object — 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.
        - `URL` string — The URL that applications should use to connect to the endpoint. The default ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.
      - `NodeCreateTime` string, date-time — 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: <code>available</code>.
      - `ParameterGroupStatus` string — The status of the parameter group associated with this node. For example, <code>in-sync</code>.
    - `PreferredMaintenanceWindow` string — A range of time when maintenance of DAX cluster software will be performed. For example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
    - `NotificationConfiguration` object — 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. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.
    - `SubnetGroup` string — The subnet group where the DAX cluster is running.
    - `SecurityGroups` SecurityGroupMembership[] — A list of security groups, and the status of each, for the nodes in the cluster.
      - `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` object — 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` String[] — The node IDs of one or more nodes to be rebooted.
    - `SSEDescription` object — The description of the server-side encryption status on the specified DAX cluster.
      - `Status` 'ENABLING' | 'ENABLED' | 'DISABLING' | 'DISABLED' — <p>The current state of server-side encryption:</p> <ul> <li> <p> <code>ENABLING</code> - Server-side encryption is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Server-side encryption is enabled.</p> </li> <li> <p> <code>DISABLING</code> - Server-side encryption is being disabled.</p> </li> <li> <p> <code>DISABLED</code> - Server-side encryption is disabled.</p> </li> </ul>
    - `ClusterEndpointEncryptionType` 'NONE' | 'TLS' — <p>The type of encryption supported by the cluster's endpoint. Values are:</p> <ul> <li> <p> <code>NONE</code> for no encryption</p> <p> <code>TLS</code> for Transport Layer Security</p> </li> </ul>

## Other responses

- `480` — ClusterNotFoundFault
- `481` — InvalidClusterStateFault
- `482` — ServiceLinkedRoleNotFoundFault
- `483` — InvalidParameterValueException
- `484` — InvalidParameterCombinationException

---

[API](https://skmtc.net/aws/apis/dax.md) · [All operations](https://skmtc.net/aws/apis/dax/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/dax/versions/ae11d18c59f6/schema)