aws_sdk_docdb/client/
delete_db_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 [`DeleteDBCluster`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`db_cluster_identifier(impl Into<String>)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::db_cluster_identifier) / [`set_db_cluster_identifier(Option<String>)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::set_db_cluster_identifier):<br>required: **true**<br><p>The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>Must match an existing <code>DBClusterIdentifier</code>.</p></li> </ul><br>
7    ///   - [`skip_final_snapshot(bool)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::skip_final_snapshot) / [`set_skip_final_snapshot(Option<bool>)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::set_skip_final_snapshot):<br>required: **false**<br><p>Determines whether a final cluster snapshot is created before the cluster is deleted. If <code>true</code> is specified, no cluster snapshot is created. If <code>false</code> is specified, a cluster snapshot is created before the DB cluster is deleted.</p><note>  <p>If <code>SkipFinalSnapshot</code> is <code>false</code>, you must specify a <code>FinalDBSnapshotIdentifier</code> parameter.</p> </note> <p>Default: <code>false</code></p><br>
8    ///   - [`final_db_snapshot_identifier(impl Into<String>)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::final_db_snapshot_identifier) / [`set_final_db_snapshot_identifier(Option<String>)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::set_final_db_snapshot_identifier):<br>required: **false**<br><p>The cluster snapshot identifier of the new cluster snapshot created when <code>SkipFinalSnapshot</code> is set to <code>false</code>.</p><note>  <p>Specifying this parameter and also setting the <code>SkipFinalShapshot</code> parameter to <code>true</code> results in an error.</p> </note> <p>Constraints:</p> <ul>  <li>   <p>Must be from 1 to 255 letters, numbers, or hyphens.</p></li>  <li>   <p>The 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    /// - On success, responds with [`DeleteDbClusterOutput`](crate::operation::delete_db_cluster::DeleteDbClusterOutput) with field(s):
10    ///   - [`db_cluster(Option<DbCluster>)`](crate::operation::delete_db_cluster::DeleteDbClusterOutput::db_cluster): <p>Detailed information about a cluster.</p>
11    /// - On failure, responds with [`SdkError<DeleteDBClusterError>`](crate::operation::delete_db_cluster::DeleteDBClusterError)
12    pub fn delete_db_cluster(&self) -> crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder {
13        crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::new(self.handle.clone())
14    }
15}
aws_sdk_docdb/client/delete_db_cluster.rs

aws_sdk_docdb/client/
delete_db_cluster.rs
