AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteCluster and EndDeleteCluster.

Namespace: Amazon.Redshift
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DeleteClusterResponse> DeleteClusterAsync(
         DeleteClusterRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Redshift.Model.DeleteClusterRequest

Container for the necessary parameters to execute the DeleteCluster service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DeleteCluster service method, as returned by Redshift.

Exceptions

ExceptionCondition
ClusterNotFoundException The ClusterIdentifier parameter does not refer to an existing cluster.
ClusterSnapshotAlreadyExistsException The value specified as a snapshot identifier is already used by an existing snapshot.
ClusterSnapshotQuotaExceededException The request would result in the user exceeding the allowed number of cluster snapshots.
InvalidClusterStateException The specified cluster is not in the available state.
InvalidRetentionPeriodException The retention period specified is either in the past or is not a valid value. The value must be either -1 or an integer between 1 and 3,653.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also