Class DeleteClusterCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { DAXClient, DeleteClusterCommand } from "@aws-sdk/client-dax"; // ES Modules import
// const { DAXClient, DeleteClusterCommand } = require("@aws-sdk/client-dax"); // CommonJS import
const client = new DAXClient(config);
const input = { // DeleteClusterRequest
  ClusterName: "STRING_VALUE", // required
};
const command = new DeleteClusterCommand(input);
const response = await client.send(command);
// { // DeleteClusterResponse
//   Cluster: { // Cluster
//     ClusterName: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     ClusterArn: "STRING_VALUE",
//     TotalNodes: Number("int"),
//     ActiveNodes: Number("int"),
//     NodeType: "STRING_VALUE",
//     Status: "STRING_VALUE",
//     ClusterDiscoveryEndpoint: { // Endpoint
//       Address: "STRING_VALUE",
//       Port: Number("int"),
//       URL: "STRING_VALUE",
//     },
//     NodeIdsToRemove: [ // NodeIdentifierList
//       "STRING_VALUE",
//     ],
//     Nodes: [ // NodeList
//       { // Node
//         NodeId: "STRING_VALUE",
//         Endpoint: {
//           Address: "STRING_VALUE",
//           Port: Number("int"),
//           URL: "STRING_VALUE",
//         },
//         NodeCreateTime: new Date("TIMESTAMP"),
//         AvailabilityZone: "STRING_VALUE",
//         NodeStatus: "STRING_VALUE",
//         ParameterGroupStatus: "STRING_VALUE",
//       },
//     ],
//     PreferredMaintenanceWindow: "STRING_VALUE",
//     NotificationConfiguration: { // NotificationConfiguration
//       TopicArn: "STRING_VALUE",
//       TopicStatus: "STRING_VALUE",
//     },
//     SubnetGroup: "STRING_VALUE",
//     SecurityGroups: [ // SecurityGroupMembershipList
//       { // SecurityGroupMembership
//         SecurityGroupIdentifier: "STRING_VALUE",
//         Status: "STRING_VALUE",
//       },
//     ],
//     IamRoleArn: "STRING_VALUE",
//     ParameterGroup: { // ParameterGroupStatus
//       ParameterGroupName: "STRING_VALUE",
//       ParameterApplyStatus: "STRING_VALUE",
//       NodeIdsToReboot: [
//         "STRING_VALUE",
//       ],
//     },
//     SSEDescription: { // SSEDescription
//       Status: "STRING_VALUE",
//     },
//     ClusterEndpointEncryptionType: "STRING_VALUE",
//   },
// };

Param

DeleteClusterCommandInput

Returns

DeleteClusterCommandOutput

See

• DeleteClusterCommandInput for command's input shape.
• DeleteClusterCommandOutput for command's response shape.
• config for DAXClient's config shape.

Throws

ClusterNotFoundFault (client fault)

The requested cluster ID does not refer to an existing DAX cluster.

Throws

InvalidClusterStateFault (client fault)

The requested DAX cluster is not in the available state.

Throws

InvalidParameterCombinationException (client fault)

Two or more incompatible parameters were specified.

Throws

InvalidParameterValueException (client fault)

The value for a parameter is invalid.

Throws

ServiceLinkedRoleNotFoundFault (client fault)

The specified service linked role (SLR) was not found.

Throws

DAXServiceException

Base exception class for all service exceptions from DAX service.