delete_db_instance¶
Operation¶
async
¶
delete_db_instance(input: DeleteDBInstanceInput, plugins: list[Plugin] | None = None) -> DeleteDBInstanceOutput
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. However, manual DB snapshots of the DB instance aren't deleted.
If you request a final DB snapshot, the status of the Amazon RDS DB
instance is deleting until the DB snapshot is created. This operation
can't be canceled or reverted after it begins. To monitor the status of
this operation, use DescribeDBInstance.
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 use the
PromoteReadReplicaDBCluster operation to promote the DB cluster so
that it's no longer a read replica. After the promotion completes, use
the DeleteDBInstance operation to delete the final instance in the DB
cluster.
Warning
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteDBInstanceInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DeleteDBInstanceOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
db_instance_identifier: str | None = ...
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.
class-attribute
instance-attribute
¶
delete_automated_backups: bool | None = ...
Specifies 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.
class-attribute
instance-attribute
¶
final_db_snapshot_identifier: str | None = ...
The DBSnapshotIdentifier of the new DBSnapshot created when the
SkipFinalSnapshot parameter is disabled.
Note
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.
class-attribute
instance-attribute
¶
skip_final_snapshot: bool | None = ...
Specifies 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.
Note
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteDBInstanceOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance,
DescribeDBInstances, ModifyDBInstance, PromoteReadReplica,
RebootDBInstance, RestoreDBInstanceFromDBSnapshot,
RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime,
StartDBInstance, and StopDBInstance.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.