Struct aws_sdk_rds::client::fluent_builders::DeleteDBInstance

pub struct DeleteDBInstance { /* private fields */ }

Fluent builder constructing a request to DeleteDBInstance.

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 DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

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:

• The DB cluster is a read replica of another Amazon Aurora DB cluster.

• The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

Implementations

impl DeleteDBInstance

pub async fn send(
    self
) -> Result<DeleteDbInstanceOutput, SdkError<DeleteDBInstanceError>>

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, which can be set when configuring the client.

pub fn db_instance_identifier(self, input: impl Into<String>) -> Self

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

• Must match the name of an existing DB instance.

pub fn set_db_instance_identifier(self, input: Option<String>) -> Self

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

• Must match the name of an existing DB instance.

pub fn skip_final_snapshot(self, input: bool) -> Self

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.

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.

If you delete a read replica or an RDS Custom instance, you must enable this setting.

This setting is required for RDS Custom.

pub fn set_skip_final_snapshot(self, input: Option<bool>) -> Self

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.

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.

If you delete a read replica or an RDS Custom instance, you must enable this setting.

This setting is required for RDS Custom.

pub fn final_db_snapshot_identifier(self, input: impl Into<String>) -> Self

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

This setting doesn't apply to RDS Custom.

Constraints:

• Must be 1 to 255 letters or numbers.

• First character must be a letter.

• Can't end with a hyphen or contain two consecutive hyphens.

• Can't be specified when deleting a read replica.

pub fn set_final_db_snapshot_identifier(self, input: Option<String>) -> Self

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

This setting doesn't apply to RDS Custom.

Constraints:

• Must be 1 to 255 letters or numbers.

• First character must be a letter.

• Can't end with a hyphen or contain two consecutive hyphens.

• Can't be specified when deleting a read replica.

pub fn delete_automated_backups(self, input: bool) -> Self

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.

pub fn set_delete_automated_backups(self, input: Option<bool>) -> Self

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.

Trait Implementations

impl Clone for DeleteDBInstance

fn clone(&self) -> DeleteDBInstance

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeleteDBInstance

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.