deleteDBInstance method

Future<DeleteDBInstanceResult> deleteDBInstance({ required String dBInstanceIdentifier, 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 Neptune 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.

Note that 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 the SkipFinalSnapshot parameter is set to true.

You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.

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

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 finalDBSnapshotIdentifier : The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false. Constraints:

• Must be 1 to 255 letters or numbers.
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens
• Cannot be specified when deleting a Read Replica.

Parameter skipFinalSnapshot : Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Note that 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 the SkipFinalSnapshot parameter is set to "true".

Specify true when deleting a Read Replica. Default: false

Implementation

Future<DeleteDBInstanceResult> deleteDBInstance({
  required String dBInstanceIdentifier,
  String? finalDBSnapshotIdentifier,
  bool? skipFinalSnapshot,
}) async {
  ArgumentError.checkNotNull(dBInstanceIdentifier, 'dBInstanceIdentifier');
  final $request = <String, dynamic>{};
  $request['DBInstanceIdentifier'] = dBInstanceIdentifier;
  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);
}