Network.AWS.RDS.DeleteDBInstance

The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot 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', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

See: AWS API Reference for DeleteDBInstance.

Creating a Request

deleteDBInstance

Arguments

:: Text

ddiDBInstanceIdentifier

-> DeleteDBInstance

Creates a value of DeleteDBInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddiFinalDBSnapshotIdentifier
• ddiSkipFinalSnapshot
• ddiDBInstanceIdentifier

data DeleteDBInstance

See: deleteDBInstance smart constructor.

Instances

Eq DeleteDBInstance

Data DeleteDBInstance

Read DeleteDBInstance

Show DeleteDBInstance

Generic DeleteDBInstance

AWSRequest DeleteDBInstance

ToPath DeleteDBInstance

ToHeaders DeleteDBInstance

ToQuery DeleteDBInstance

Typeable * DeleteDBInstance

type Rep DeleteDBInstance

type Rs DeleteDBInstance = DeleteDBInstanceResponse

Request Lenses

ddiFinalDBSnapshotIdentifier :: Lens' DeleteDBInstance (Maybe Text)

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 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens
• Cannot be specified when deleting a Read Replica.

ddiSkipFinalSnapshot :: Lens' DeleteDBInstance (Maybe Bool)

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

ddiDBInstanceIdentifier :: Lens' DeleteDBInstance Text

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Destructuring the Response

deleteDBInstanceResponse

Arguments

:: Int

ddirsStatus

-> DeleteDBInstanceResponse

Creates a value of DeleteDBInstanceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddirsDBInstance
• ddirsStatus

data DeleteDBInstanceResponse

See: deleteDBInstanceResponse smart constructor.

Instances

Eq DeleteDBInstanceResponse

Data DeleteDBInstanceResponse

Read DeleteDBInstanceResponse

Show DeleteDBInstanceResponse

Generic DeleteDBInstanceResponse

Typeable * DeleteDBInstanceResponse

type Rep DeleteDBInstanceResponse

Response Lenses

ddirsDBInstance :: Lens' DeleteDBInstanceResponse (Maybe DBInstance)

Undocumented member.

ddirsStatus :: Lens' DeleteDBInstanceResponse Int

The response status code.