Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.DeleteDBInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data DeleteDBInstance = DeleteDBInstance' {
- deleteAutomatedBackups :: Maybe Bool
- finalDBSnapshotIdentifier :: Maybe Text
- skipFinalSnapshot :: Maybe Bool
- dbInstanceIdentifier :: Text
}
newDeleteDBInstance :: Text -> DeleteDBInstance
deleteDBInstance_deleteAutomatedBackups :: Lens' DeleteDBInstance (Maybe Bool)
deleteDBInstance_finalDBSnapshotIdentifier :: Lens' DeleteDBInstance (Maybe Text)
deleteDBInstance_skipFinalSnapshot :: Lens' DeleteDBInstance (Maybe Bool)
deleteDBInstance_dbInstanceIdentifier :: Lens' DeleteDBInstance Text
data DeleteDBInstanceResponse = DeleteDBInstanceResponse' {
- dbInstance :: Maybe DBInstance
- httpStatus :: Int
}
newDeleteDBInstanceResponse :: Int -> DeleteDBInstanceResponse
deleteDBInstanceResponse_dbInstance :: Lens' DeleteDBInstanceResponse (Maybe DBInstance)
deleteDBInstanceResponse_httpStatus :: Lens' DeleteDBInstanceResponse Int

Creating a Request

data DeleteDBInstance Source #

See: newDeleteDBInstance smart constructor.

Constructors

DeleteDBInstance'

Fields

deleteAutomatedBackups :: Maybe Bool
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.
finalDBSnapshotIdentifier :: Maybe Text
The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
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.
skipFinalSnapshot :: Maybe Bool
A value that indicates 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.
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.
dbInstanceIdentifier :: Text
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.

Instances

Instances details

ToHeaders DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods toHeaders :: DeleteDBInstance -> [Header] #
ToPath DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods toPath :: DeleteDBInstance -> ByteString #
ToQuery DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods toQuery :: DeleteDBInstance -> QueryString #
AWSRequest DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Associated Types type AWSResponse DeleteDBInstance # Methods request :: (Service -> Service) -> DeleteDBInstance -> Request DeleteDBInstance # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteDBInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDBInstance))) #
Generic DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Associated Types type Rep DeleteDBInstance :: Type -> Type # Methods from :: DeleteDBInstance -> Rep DeleteDBInstance x # to :: Rep DeleteDBInstance x -> DeleteDBInstance #
Read DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods readsPrec :: Int -> ReadS DeleteDBInstance # readList :: ReadS [DeleteDBInstance] # readPrec :: ReadPrec DeleteDBInstance # readListPrec :: ReadPrec [DeleteDBInstance] #
Show DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods showsPrec :: Int -> DeleteDBInstance -> ShowS # show :: DeleteDBInstance -> String # showList :: [DeleteDBInstance] -> ShowS #
NFData DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods rnf :: DeleteDBInstance -> () #
Eq DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods (==) :: DeleteDBInstance -> DeleteDBInstance -> Bool # (/=) :: DeleteDBInstance -> DeleteDBInstance -> Bool #
Hashable DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods hashWithSalt :: Int -> DeleteDBInstance -> Int # hash :: DeleteDBInstance -> Int #
type AWSResponse DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance type AWSResponse DeleteDBInstance = DeleteDBInstanceResponse
type Rep DeleteDBInstance Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance type Rep DeleteDBInstance = D1 ('MetaData "DeleteDBInstance" "Amazonka.RDS.DeleteDBInstance" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DeleteDBInstance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deleteAutomatedBackups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "finalDBSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "skipFinalSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteDBInstance Source #

Arguments

:: Text	`DeleteDBInstance`
-> DeleteDBInstance

Create a value of DeleteDBInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deleteAutomatedBackups:DeleteDBInstance', deleteDBInstance_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.

$sel:finalDBSnapshotIdentifier:DeleteDBInstance', deleteDBInstance_finalDBSnapshotIdentifier - The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

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.

$sel:skipFinalSnapshot:DeleteDBInstance', deleteDBInstance_skipFinalSnapshot - A value that indicates 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.

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.

DeleteDBInstance, deleteDBInstance_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.

Request Lenses

deleteDBInstance_deleteAutomatedBackups :: Lens' DeleteDBInstance (Maybe Bool) Source #

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.

deleteDBInstance_finalDBSnapshotIdentifier :: Lens' DeleteDBInstance (Maybe Text) Source #

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

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.

deleteDBInstance_skipFinalSnapshot :: Lens' DeleteDBInstance (Maybe Bool) Source #

A value that indicates 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.

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.

deleteDBInstance_dbInstanceIdentifier :: Lens' DeleteDBInstance Text Source #

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.

Destructuring the Response

data DeleteDBInstanceResponse Source #

See: newDeleteDBInstanceResponse smart constructor.

Constructors

DeleteDBInstanceResponse'
Fields dbInstance :: Maybe DBInstance httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Associated Types type Rep DeleteDBInstanceResponse :: Type -> Type # Methods from :: DeleteDBInstanceResponse -> Rep DeleteDBInstanceResponse x # to :: Rep DeleteDBInstanceResponse x -> DeleteDBInstanceResponse #
Read DeleteDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods readsPrec :: Int -> ReadS DeleteDBInstanceResponse # readList :: ReadS [DeleteDBInstanceResponse] # readPrec :: ReadPrec DeleteDBInstanceResponse # readListPrec :: ReadPrec [DeleteDBInstanceResponse] #
Show DeleteDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods showsPrec :: Int -> DeleteDBInstanceResponse -> ShowS # show :: DeleteDBInstanceResponse -> String # showList :: [DeleteDBInstanceResponse] -> ShowS #
NFData DeleteDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods rnf :: DeleteDBInstanceResponse -> () #
Eq DeleteDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance Methods (==) :: DeleteDBInstanceResponse -> DeleteDBInstanceResponse -> Bool # (/=) :: DeleteDBInstanceResponse -> DeleteDBInstanceResponse -> Bool #
type Rep DeleteDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.DeleteDBInstance type Rep DeleteDBInstanceResponse = D1 ('MetaData "DeleteDBInstanceResponse" "Amazonka.RDS.DeleteDBInstance" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DeleteDBInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteDBInstanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteDBInstanceResponse'`
-> DeleteDBInstanceResponse

Create a value of DeleteDBInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbInstance:DeleteDBInstanceResponse', deleteDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:DeleteDBInstanceResponse', deleteDBInstanceResponse_httpStatus - The response's http status code.

Response Lenses

deleteDBInstanceResponse_dbInstance :: Lens' DeleteDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

deleteDBInstanceResponse_httpStatus :: Lens' DeleteDBInstanceResponse Int Source #

The response's http status code.