1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::delete_db_instance::_delete_db_instance_output::DeleteDbInstanceOutputBuilder;
pub use crate::operation::delete_db_instance::_delete_db_instance_input::DeleteDbInstanceInputBuilder;
/// Fluent builder constructing a request to `DeleteDBInstance`.
///
/// <p>The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by <code>DeleteDBInstance</code> are not deleted.</p>
/// <p>If you request a final DB snapshot the status of the Amazon RDS DB instance is <code>deleting</code> until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.</p>
/// <p>When a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, you can only delete it when you skip creation of the final snapshot with the <code>SkipFinalSnapshot</code> parameter.</p>
/// <p>If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:</p>
/// <ul>
/// <li> <p>The DB cluster is a read replica of another Amazon Aurora DB cluster.</p> </li>
/// <li> <p>The DB instance is the only instance in the DB cluster.</p> </li>
/// </ul>
/// <p>To delete a DB instance in this case, first call the <code>PromoteReadReplicaDBCluster</code> API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the <code>DeleteDBInstance</code> API action to delete the final instance in the DB cluster.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteDBInstanceFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::delete_db_instance::builders::DeleteDbInstanceInputBuilder,
}
impl DeleteDBInstanceFluentBuilder {
/// Creates a new `DeleteDBInstance`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::delete_db_instance::DeleteDBInstance,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::delete_db_instance::DeleteDBInstanceError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::delete_db_instance::DeleteDbInstanceOutput,
aws_smithy_http::result::SdkError<
crate::operation::delete_db_instance::DeleteDBInstanceError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li> <p>Must match the name of an existing DB instance.</p> </li>
/// </ul>
pub fn db_instance_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.db_instance_identifier(input.into());
self
}
/// <p>The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li> <p>Must match the name of an existing DB instance.</p> </li>
/// </ul>
pub fn set_db_instance_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_db_instance_identifier(input);
self
}
/// <p>A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.</p> <note>
/// <p>If you don't enable this parameter, you must specify the <code>FinalDBSnapshotIdentifier</code> parameter.</p>
/// </note>
/// <p>When a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, RDS can delete the instance only if you enable this parameter.</p>
/// <p>If you delete a read replica or an RDS Custom instance, you must enable this setting.</p>
/// <p>This setting is required for RDS Custom.</p>
pub fn skip_final_snapshot(mut self, input: bool) -> Self {
self.inner = self.inner.skip_final_snapshot(input);
self
}
/// <p>A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.</p> <note>
/// <p>If you don't enable this parameter, you must specify the <code>FinalDBSnapshotIdentifier</code> parameter.</p>
/// </note>
/// <p>When a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, RDS can delete the instance only if you enable this parameter.</p>
/// <p>If you delete a read replica or an RDS Custom instance, you must enable this setting.</p>
/// <p>This setting is required for RDS Custom.</p>
pub fn set_skip_final_snapshot(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_skip_final_snapshot(input);
self
}
/// <p>The <code>DBSnapshotIdentifier</code> of the new <code>DBSnapshot</code> created when the <code>SkipFinalSnapshot</code> parameter is disabled.</p> <note>
/// <p>If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.</p>
/// </note>
/// <p>This setting doesn't apply to RDS Custom.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li> <p>Must be 1 to 255 letters or numbers.</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>
/// <li> <p>Can't be specified when deleting a read replica.</p> </li>
/// </ul>
pub fn final_db_snapshot_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.final_db_snapshot_identifier(input.into());
self
}
/// <p>The <code>DBSnapshotIdentifier</code> of the new <code>DBSnapshot</code> created when the <code>SkipFinalSnapshot</code> parameter is disabled.</p> <note>
/// <p>If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.</p>
/// </note>
/// <p>This setting doesn't apply to RDS Custom.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li> <p>Must be 1 to 255 letters or numbers.</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>
/// <li> <p>Can't be specified when deleting a read replica.</p> </li>
/// </ul>
pub fn set_final_db_snapshot_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_final_db_snapshot_identifier(input);
self
}
/// <p>A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.</p>
pub fn delete_automated_backups(mut self, input: bool) -> Self {
self.inner = self.inner.delete_automated_backups(input);
self
}
/// <p>A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.</p>
pub fn set_delete_automated_backups(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_delete_automated_backups(input);
self
}
}