aws_sdk_rds/client/

delete_db_cluster.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DeleteDBCluster`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`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 DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>Must match an existing DBClusterIdentifier.</p></li> </ul><br>
    ///   - [`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>Specifies whether to skip the creation of a final DB cluster snapshot before RDS deletes the DB cluster. If you set this value to <code>true</code>, RDS doesn't create a final DB cluster snapshot. If you set this value to <code>false</code> or don't specify it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this parameter is disabled, so RDS creates a final DB cluster snapshot.</p><note>  <p>If <code>SkipFinalSnapshot</code> is disabled, you must specify a value for the <code>FinalDBSnapshotIdentifier</code> parameter.</p> </note><br>
    ///   - [`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 DB cluster snapshot identifier of the new DB cluster snapshot created when <code>SkipFinalSnapshot</code> is disabled.</p><note>  <p>If you specify this parameter and also skip the creation of a final DB cluster snapshot with the <code>SkipFinalShapshot</code> parameter, the request results in an error.</p> </note> <p>Constraints:</p> <ul>  <li>   <p>Must be 1 to 255 letters, numbers, or hyphens.</p></li>  <li>   <p>First character must be a letter</p></li>  <li>   <p>Can't end with a hyphen or contain two consecutive hyphens</p></li> </ul><br>
    ///   - [`delete_automated_backups(bool)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::delete_automated_backups) / [`set_delete_automated_backups(Option<bool>)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::set_delete_automated_backups):<br>required: **false**<br><p>Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the Amazon Web Services Backup policy specifies a point-in-time restore rule.</p><br>
    /// - On success, responds with [`DeleteDbClusterOutput`](crate::operation::delete_db_cluster::DeleteDbClusterOutput) with field(s):
    ///   - [`db_cluster(Option<DbCluster>)`](crate::operation::delete_db_cluster::DeleteDbClusterOutput::db_cluster): <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.</p> <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>, <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>, <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>, <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p> <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>, <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>, <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p> <p>For more information on Amazon Aurora DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i></p> <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i></p>
    /// - On failure, responds with [`SdkError<DeleteDBClusterError>`](crate::operation::delete_db_cluster::DeleteDBClusterError)
    pub fn delete_db_cluster(&self) -> crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder {
        crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::new(self.handle.clone())
    }
}