DeleteDBInstanceRequest Class | AWS SDK for .NET V3

Container for the parameters to the DeleteDBInstance operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptune.AmazonNeptuneRequest
      Amazon.Neptune.Model.DeleteDBInstanceRequest

Namespace: Amazon.Neptune.Model
Assembly: AWSSDK.Neptune.dll
Version: 3.x.y.z

Syntax

public class DeleteDBInstanceRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest

The DeleteDBInstanceRequest type exposes the following members

Constructors

	Name	Description
	DeleteDBInstanceRequest()

Properties

Name Type Description

Name	Type	Description
DBInstanceIdentifier	System.String	Gets and sets the property 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.
FinalDBSnapshotIdentifier	System.String	Gets and sets the property FinalDBSnapshotIdentifier. The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to `false`. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. 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.
SkipFinalSnapshot	System.Boolean	Gets and sets the property 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. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is `false`. Default: `false`

DBInstanceIdentifier

System.String

Gets and sets the property 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.

FinalDBSnapshotIdentifier

System.String

Gets and sets the property FinalDBSnapshotIdentifier.

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

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.

SkipFinalSnapshot

System.Boolean

Gets and sets the property 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.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

Examples

This example deletes the specified DB instance.

To delete a DB instance.


var response = client.DeleteDBInstance(new DeleteDBInstanceRequest 
{
    DBInstanceIdentifier = "mymysqlinstance",
    SkipFinalSnapshot = true
});

DBInstance dbInstance = response.DBInstance;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5