libZSservicesZSamazonka-neptuneZSamazonka-neptune
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Neptune.DeleteDBInstance

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

Synopsis

Creating a Request

data DeleteDBInstance Source #

See: newDeleteDBInstance smart constructor.

Constructors

DeleteDBInstance' 

Fields

  • finalDBSnapshotIdentifier :: 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 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 :: 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

  • 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
Eq DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

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

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

Read DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

readsPrec :: Int -> ReadS DeleteDBInstance #

readList :: ReadS [DeleteDBInstance] #

readPrec :: ReadPrec DeleteDBInstance #

readListPrec :: ReadPrec [DeleteDBInstance] #

Show DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

showsPrec :: Int -> DeleteDBInstance -> ShowS #

show :: DeleteDBInstance -> String #

showList :: [DeleteDBInstance] -> ShowS #

Generic DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Associated Types

type Rep DeleteDBInstance :: Type -> Type #

Methods

from :: DeleteDBInstance -> Rep DeleteDBInstance x #

to :: Rep DeleteDBInstance x -> DeleteDBInstance #

NFData DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

rnf :: DeleteDBInstance -> () #

Hashable DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

hashWithSalt :: Int -> DeleteDBInstance -> Int #

hash :: DeleteDBInstance -> Int #

AWSRequest DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Associated Types

type AWSResponse DeleteDBInstance #

Methods

request :: DeleteDBInstance -> Request DeleteDBInstance #

response :: MonadResource m => Logger -> Service -> Proxy DeleteDBInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDBInstance))) #

ToHeaders DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

toHeaders :: DeleteDBInstance -> [Header] #

ToPath DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

toPath :: DeleteDBInstance -> ByteString #

ToQuery DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

toQuery :: DeleteDBInstance -> QueryString #

type Rep DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

type Rep DeleteDBInstance = D1 ('MetaData "DeleteDBInstance" "Amazonka.Neptune.DeleteDBInstance" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "DeleteDBInstance'" 'PrefixI 'True) (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))))
type AWSResponse DeleteDBInstance Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

type AWSResponse DeleteDBInstance = DeleteDBInstanceResponse

newDeleteDBInstance Source #

Arguments

:: Text

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

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

$sel:dbInstanceIdentifier: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_finalDBSnapshotIdentifier :: Lens' DeleteDBInstance (Maybe Text) Source #

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.

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

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

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

Instances

Instances details
Eq DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

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

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

Read DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

readsPrec :: Int -> ReadS DeleteDBInstanceResponse #

readList :: ReadS [DeleteDBInstanceResponse] #

readPrec :: ReadPrec DeleteDBInstanceResponse #

readListPrec :: ReadPrec [DeleteDBInstanceResponse] #

Show DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

showsPrec :: Int -> DeleteDBInstanceResponse -> ShowS #

show :: DeleteDBInstanceResponse -> String #

showList :: [DeleteDBInstanceResponse] -> ShowS #

Generic DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Associated Types

type Rep DeleteDBInstanceResponse :: Type -> Type #

Methods

from :: DeleteDBInstanceResponse -> Rep DeleteDBInstanceResponse x #

to :: Rep DeleteDBInstanceResponse x -> DeleteDBInstanceResponse #

NFData DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

Methods

rnf :: DeleteDBInstanceResponse -> () #

type Rep DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.Neptune.DeleteDBInstance

type Rep DeleteDBInstanceResponse = D1 ('MetaData "DeleteDBInstanceResponse" "Amazonka.Neptune.DeleteDBInstance" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.