deleteDBInstance method

Future<DeleteDBInstanceResult> deleteDBInstance({ required String dBInstanceIdentifier, bool? deleteAutomatedBackups, String? finalDBSnapshotIdentifier, bool? skipFinalSnapshot, })

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.

May throw DBInstanceNotFoundFault. May throw InvalidDBInstanceStateFault. May throw DBSnapshotAlreadyExistsFault. May throw SnapshotQuotaExceededFault. May throw InvalidDBClusterStateFault. May throw DBInstanceAutomatedBackupQuotaExceededFault.

Parameter dBInstanceIdentifier : 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.

Parameter deleteAutomatedBackups : 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.

Parameter finalDBSnapshotIdentifier : The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled. 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.

Parameter skipFinalSnapshot : A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a read replica.

Implementation

Future<DeleteDBInstanceResult> deleteDBInstance({
  required String dBInstanceIdentifier,
  bool? deleteAutomatedBackups,
  String? finalDBSnapshotIdentifier,
  bool? skipFinalSnapshot,
}) async {
  ArgumentError.checkNotNull(dBInstanceIdentifier, 'dBInstanceIdentifier');
  final $request = <String, dynamic>{};
  $request['DBInstanceIdentifier'] = dBInstanceIdentifier;
  deleteAutomatedBackups
      ?.also((arg) => $request['DeleteAutomatedBackups'] = arg);
  finalDBSnapshotIdentifier
      ?.also((arg) => $request['FinalDBSnapshotIdentifier'] = arg);
  skipFinalSnapshot?.also((arg) => $request['SkipFinalSnapshot'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DeleteDBInstance',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DeleteDBInstanceMessage'],
    shapes: shapes,
    resultWrapper: 'DeleteDBInstanceResult',
  );
  return DeleteDBInstanceResult.fromXml($result);
}