Network.AWS.RDS.DeleteDBInstance

The DeleteDBInstance action deletes a previously provisioned DB instance. 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 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 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 , you can only delete it when the SkipFinalSnapshot parameter is set to true .

If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot 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.

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 - 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.
• ddiSkipFinalSnapshot - 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
• ddiDBInstanceIdentifier - 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.

data DeleteDBInstance

See: deleteDBInstance smart constructor.

Instances

Eq DeleteDBInstance

Methods

(==) :: DeleteDBInstance -> DeleteDBInstance -> Bool

(/=) :: DeleteDBInstance -> DeleteDBInstance -> Bool

Data DeleteDBInstance

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteDBInstance -> c DeleteDBInstance

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteDBInstance

toConstr :: DeleteDBInstance -> Constr

dataTypeOf :: DeleteDBInstance -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteDBInstance)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteDBInstance)

gmapT :: (forall b. Data b => b -> b) -> DeleteDBInstance -> DeleteDBInstance

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDBInstance -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDBInstance -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteDBInstance -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteDBInstance -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteDBInstance -> m DeleteDBInstance

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDBInstance -> m DeleteDBInstance

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDBInstance -> m DeleteDBInstance

Read DeleteDBInstance

Methods

readsPrec :: Int -> ReadS DeleteDBInstance

readList :: ReadS [DeleteDBInstance]

readPrec :: ReadPrec DeleteDBInstance

readListPrec :: ReadPrec [DeleteDBInstance]

Show DeleteDBInstance

Methods

showsPrec :: Int -> DeleteDBInstance -> ShowS

show :: DeleteDBInstance -> String

showList :: [DeleteDBInstance] -> ShowS

Generic DeleteDBInstance

Associated Types

type Rep DeleteDBInstance :: * -> *

Methods

from :: DeleteDBInstance -> Rep DeleteDBInstance x

to :: Rep DeleteDBInstance x -> DeleteDBInstance

Hashable DeleteDBInstance

Methods

hashWithSalt :: Int -> DeleteDBInstance -> Int

hash :: DeleteDBInstance -> Int

NFData DeleteDBInstance

Methods

rnf :: DeleteDBInstance -> ()

AWSRequest DeleteDBInstance

Associated Types

type Rs DeleteDBInstance :: *

Methods

request :: DeleteDBInstance -> Request DeleteDBInstance

response :: MonadResource m => Logger -> Service -> Proxy * DeleteDBInstance -> ClientResponse -> m (Response DeleteDBInstance)

ToQuery DeleteDBInstance

Methods

toQuery :: DeleteDBInstance -> QueryString

ToPath DeleteDBInstance

Methods

toPath :: DeleteDBInstance -> ByteString

ToHeaders DeleteDBInstance

Methods

toHeaders :: DeleteDBInstance -> [Header]

type Rep DeleteDBInstance

type Rep DeleteDBInstance = D1 (MetaData "DeleteDBInstance" "Network.AWS.RDS.DeleteDBInstance" "amazonka-rds-1.5.0-4pv5DetELOaBXetw2fB1GM" False) (C1 (MetaCons "DeleteDBInstance'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddiFinalDBSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ddiSkipFinalSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_ddiDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs 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 . 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.

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. 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 match the name of an existing DB instance.

Destructuring the Response

deleteDBInstanceResponse

Arguments

:: Int

ddirsResponseStatus

-> 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 - Undocumented member.
• ddirsResponseStatus - -- | The response status code.

data DeleteDBInstanceResponse

See: deleteDBInstanceResponse smart constructor.

Instances

Eq DeleteDBInstanceResponse

Methods

(==) :: DeleteDBInstanceResponse -> DeleteDBInstanceResponse -> Bool

(/=) :: DeleteDBInstanceResponse -> DeleteDBInstanceResponse -> Bool

Data DeleteDBInstanceResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteDBInstanceResponse -> c DeleteDBInstanceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteDBInstanceResponse

toConstr :: DeleteDBInstanceResponse -> Constr

dataTypeOf :: DeleteDBInstanceResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteDBInstanceResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteDBInstanceResponse)

gmapT :: (forall b. Data b => b -> b) -> DeleteDBInstanceResponse -> DeleteDBInstanceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDBInstanceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDBInstanceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteDBInstanceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteDBInstanceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteDBInstanceResponse -> m DeleteDBInstanceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDBInstanceResponse -> m DeleteDBInstanceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDBInstanceResponse -> m DeleteDBInstanceResponse

Read DeleteDBInstanceResponse

Methods

readsPrec :: Int -> ReadS DeleteDBInstanceResponse

readList :: ReadS [DeleteDBInstanceResponse]

readPrec :: ReadPrec DeleteDBInstanceResponse

readListPrec :: ReadPrec [DeleteDBInstanceResponse]

Show DeleteDBInstanceResponse

Methods

showsPrec :: Int -> DeleteDBInstanceResponse -> ShowS

show :: DeleteDBInstanceResponse -> String

showList :: [DeleteDBInstanceResponse] -> ShowS

Generic DeleteDBInstanceResponse

Associated Types

type Rep DeleteDBInstanceResponse :: * -> *

Methods

from :: DeleteDBInstanceResponse -> Rep DeleteDBInstanceResponse x

to :: Rep DeleteDBInstanceResponse x -> DeleteDBInstanceResponse

NFData DeleteDBInstanceResponse

Methods

rnf :: DeleteDBInstanceResponse -> ()

type Rep DeleteDBInstanceResponse

type Rep DeleteDBInstanceResponse = D1 (MetaData "DeleteDBInstanceResponse" "Network.AWS.RDS.DeleteDBInstance" "amazonka-rds-1.5.0-4pv5DetELOaBXetw2fB1GM" False) (C1 (MetaCons "DeleteDBInstanceResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddirsDBInstance") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBInstance))) (S1 (MetaSel (Just Symbol "_ddirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ddirsDBInstance :: Lens' DeleteDBInstanceResponse (Maybe DBInstance)

Undocumented member.

ddirsResponseStatus :: Lens' DeleteDBInstanceResponse Int

• - | The response status code.