pub struct DeleteClusterFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DeleteCluster
.
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.
Implementations§
source§impl DeleteClusterFluentBuilder
impl DeleteClusterFluentBuilder
sourcepub fn as_input(&self) -> &DeleteClusterInputBuilder
pub fn as_input(&self) -> &DeleteClusterInputBuilder
Access the DeleteCluster as a reference.
sourcepub async fn send(
self
) -> Result<DeleteClusterOutput, SdkError<DeleteClusterError, HttpResponse>>
pub async fn send( self ) -> Result<DeleteClusterOutput, SdkError<DeleteClusterError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<DeleteClusterOutput, DeleteClusterError, Self>
pub fn customize( self ) -> CustomizableOperation<DeleteClusterOutput, DeleteClusterError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn cluster_identifier(self, input: impl Into<String>) -> Self
pub fn cluster_identifier(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_cluster_identifier(self, input: Option<String>) -> Self
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.
sourcepub fn get_cluster_identifier(&self) -> &Option<String>
pub fn get_cluster_identifier(&self) -> &Option<String>
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.
sourcepub fn skip_final_cluster_snapshot(self, input: bool) -> Self
pub fn skip_final_cluster_snapshot(self, input: bool) -> Self
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
sourcepub fn set_skip_final_cluster_snapshot(self, input: Option<bool>) -> Self
pub fn set_skip_final_cluster_snapshot(self, input: Option<bool>) -> Self
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
sourcepub fn get_skip_final_cluster_snapshot(&self) -> &Option<bool>
pub fn get_skip_final_cluster_snapshot(&self) -> &Option<bool>
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
sourcepub fn final_cluster_snapshot_identifier(self, input: impl Into<String>) -> Self
pub fn final_cluster_snapshot_identifier(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_final_cluster_snapshot_identifier(
self,
input: Option<String>
) -> Self
pub fn set_final_cluster_snapshot_identifier( self, input: Option<String> ) -> Self
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.
sourcepub fn get_final_cluster_snapshot_identifier(&self) -> &Option<String>
pub fn get_final_cluster_snapshot_identifier(&self) -> &Option<String>
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.
sourcepub fn final_cluster_snapshot_retention_period(self, input: i32) -> Self
pub fn final_cluster_snapshot_retention_period(self, input: i32) -> Self
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
sourcepub fn set_final_cluster_snapshot_retention_period(
self,
input: Option<i32>
) -> Self
pub fn set_final_cluster_snapshot_retention_period( self, input: Option<i32> ) -> Self
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
sourcepub fn get_final_cluster_snapshot_retention_period(&self) -> &Option<i32>
pub fn get_final_cluster_snapshot_retention_period(&self) -> &Option<i32>
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
Trait Implementations§
source§impl Clone for DeleteClusterFluentBuilder
impl Clone for DeleteClusterFluentBuilder
source§fn clone(&self) -> DeleteClusterFluentBuilder
fn clone(&self) -> DeleteClusterFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more