1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// 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): <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>
/// - [`skip_final_snapshot(bool)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::skip_final_snapshot) / [`set_skip_final_snapshot(bool)`](crate::operation::delete_db_cluster::builders::DeleteDBClusterFluentBuilder::set_skip_final_snapshot): <p>A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.</p> <note> <p>You must specify a <code>FinalDBSnapshotIdentifier</code> parameter if <code>SkipFinalSnapshot</code> is disabled.</p> </note>
/// - [`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): <p>The DB cluster snapshot identifier of the new DB cluster snapshot created when <code>SkipFinalSnapshot</code> is disabled.</p> <note> <p>Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the <code>SkipFinalShapshot</code> parameter 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>
/// - 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(),
)
}
}