aws_sdk_redshift/client/
delete_cluster.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DeleteCluster`](crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_identifier(impl Into<String>)`](crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder::set_cluster_identifier):<br>required: **true**<br><p>The identifier of the cluster to be deleted.</p> <p>Constraints:</p> <ul>  <li>   <p>Must contain lowercase characters.</p></li>  <li>   <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p></li>  <li>   <p>First character must be a letter.</p></li>  <li>   <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li> </ul><br>
7    ///   - [`skip_final_cluster_snapshot(bool)`](crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder::skip_final_cluster_snapshot) / [`set_skip_final_cluster_snapshot(Option<bool>)`](crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder::set_skip_final_cluster_snapshot):<br>required: **false**<br><p>Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If <code>false</code>, a final cluster snapshot is created before the cluster is deleted.</p><note>  <p>The <i>FinalClusterSnapshotIdentifier</i> parameter must be specified if <i>SkipFinalClusterSnapshot</i> is <code>false</code>.</p> </note> <p>Default: <code>false</code></p><br>
8    ///   - [`final_cluster_snapshot_identifier(impl Into<String>)`](crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder::final_cluster_snapshot_identifier) / [`set_final_cluster_snapshot_identifier(Option<String>)`](crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder::set_final_cluster_snapshot_identifier):<br>required: **false**<br><p>The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, <i>SkipFinalClusterSnapshot</i> must be <code>false</code>.</p> <p>Constraints:</p> <ul>  <li>   <p>Must be 1 to 255 alphanumeric characters.</p></li>  <li>   <p>First character must be a letter.</p></li>  <li>   <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li> </ul><br>
9    ///   - [`final_cluster_snapshot_retention_period(i32)`](crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder::final_cluster_snapshot_retention_period) / [`set_final_cluster_snapshot_retention_period(Option<i32>)`](crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder::set_final_cluster_snapshot_retention_period):<br>required: **false**<br><p>The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p> <p>The default value is -1.</p><br>
10    /// - On success, responds with [`DeleteClusterOutput`](crate::operation::delete_cluster::DeleteClusterOutput) with field(s):
11    ///   - [`cluster(Option<Cluster>)`](crate::operation::delete_cluster::DeleteClusterOutput::cluster): <p>Describes a cluster.</p>
12    /// - On failure, responds with [`SdkError<DeleteClusterError>`](crate::operation::delete_cluster::DeleteClusterError)
13    pub fn delete_cluster(&self) -> crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder {
14        crate::operation::delete_cluster::builders::DeleteClusterFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_redshift/client/delete_cluster.rs

aws_sdk_redshift/client/
delete_cluster.rs
