Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeleteClusterCommand

Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster.

For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

example

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

import { RedshiftClient, DeleteClusterCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, DeleteClusterCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const command = new DeleteClusterCommand(input);
const response = await client.send(command);
see

DeleteClusterCommandInput for command's input shape.

see

DeleteClusterCommandOutput for command's response shape.

see

config for RedshiftClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: DeleteClusterCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<DeleteClusterCommandInput, DeleteClusterCommandOutput>

Methods

Static getEndpointParameterInstructions