com.amazonaws.services.redshift.model

Class DeleteClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshift.model.DeleteClusterRequest

All Implemented Interfaces:

Serializable

public class DeleteClusterRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DeleteCluster operation.

Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. 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. 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 Management Guide .

See Also:

AmazonRedshift.deleteCluster(DeleteClusterRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteClusterRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClusterIdentifier() The identifier of the cluster to be deleted.
String	getFinalClusterSnapshotIdentifier() The identifier of the final snapshot that is to be created immediately before deleting the cluster.
Boolean	getSkipFinalClusterSnapshot() Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster.
int	hashCode()
Boolean	isSkipFinalClusterSnapshot() Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster.
void	setClusterIdentifier(String clusterIdentifier) The identifier of the cluster to be deleted.
void	setFinalClusterSnapshotIdentifier(String finalClusterSnapshotIdentifier) The identifier of the final snapshot that is to be created immediately before deleting the cluster.
void	setSkipFinalClusterSnapshot(Boolean skipFinalClusterSnapshot) Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteClusterRequest	withClusterIdentifier(String clusterIdentifier) The identifier of the cluster to be deleted.
DeleteClusterRequest	withFinalClusterSnapshotIdentifier(String finalClusterSnapshotIdentifier) The identifier of the final snapshot that is to be created immediately before deleting the cluster.
DeleteClusterRequest	withSkipFinalClusterSnapshot(Boolean skipFinalClusterSnapshot) Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteClusterRequest

public DeleteClusterRequest()

Method Detail

getClusterIdentifier

public String getClusterIdentifier()

The identifier of the cluster to be deleted.

Constraints:

• Must contain lowercase characters.
• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

The identifier of the cluster to be deleted.

Constraints:

• Must contain lowercase characters.
• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

setClusterIdentifier

public void setClusterIdentifier(String clusterIdentifier)

The identifier of the cluster to be deleted.

Constraints:

• Must contain lowercase characters.
• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Parameters:

clusterIdentifier - The identifier of the cluster to be deleted.

Constraints:

• Must contain lowercase characters.
• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

withClusterIdentifier

public DeleteClusterRequest withClusterIdentifier(String clusterIdentifier)

The identifier of the cluster to be deleted.

Constraints:

• Must contain lowercase characters.
• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Returns a reference to this object so that method calls can be chained together.

Parameters:

clusterIdentifier - The identifier of the cluster to be deleted.

Constraints:

• Must contain lowercase characters.
• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

A reference to this updated object so that method calls can be chained together.

isSkipFinalClusterSnapshot

public Boolean isSkipFinalClusterSnapshot()

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Returns:

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

setSkipFinalClusterSnapshot

public void setSkipFinalClusterSnapshot(Boolean skipFinalClusterSnapshot)

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Parameters:

skipFinalClusterSnapshot - Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

withSkipFinalClusterSnapshot

public DeleteClusterRequest withSkipFinalClusterSnapshot(Boolean skipFinalClusterSnapshot)

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Returns a reference to this object so that method calls can be chained together.

Parameters:

skipFinalClusterSnapshot - Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Returns:

A reference to this updated object so that method calls can be chained together.

getSkipFinalClusterSnapshot

public Boolean getSkipFinalClusterSnapshot()

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Returns:

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

getFinalClusterSnapshotIdentifier

public String getFinalClusterSnapshotIdentifier()

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

• Must be 1 to 255 alphanumeric characters.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

• Must be 1 to 255 alphanumeric characters.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

setFinalClusterSnapshotIdentifier

public void setFinalClusterSnapshotIdentifier(String finalClusterSnapshotIdentifier)

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

• Must be 1 to 255 alphanumeric characters.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Parameters:

finalClusterSnapshotIdentifier - The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

• Must be 1 to 255 alphanumeric characters.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

withFinalClusterSnapshotIdentifier

public DeleteClusterRequest withFinalClusterSnapshotIdentifier(String finalClusterSnapshotIdentifier)

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

• Must be 1 to 255 alphanumeric characters.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Returns a reference to this object so that method calls can be chained together.

Parameters:

finalClusterSnapshotIdentifier - The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

• Must be 1 to 255 alphanumeric characters.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object