libZSservicesZSamazonka-rdsZSamazonka-rds
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.RDS.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 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

Creating a Request

data DeleteDBInstance Source #

See: newDeleteDBInstance smart constructor.

Constructors

DeleteDBInstance' 

Fields

  • finalDBSnapshotIdentifier :: Maybe Text

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

    Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

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

  • skipFinalSnapshot :: Maybe Bool

    A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

    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 skip is specified.

    Specify skip when deleting a read replica.

    The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

  • 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.RDS.DeleteDBInstance

Read DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

Show DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

Generic DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

Associated Types

type Rep DeleteDBInstance :: Type -> Type #

NFData DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

Methods

rnf :: DeleteDBInstance -> () #

Hashable DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

AWSRequest DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

Associated Types

type AWSResponse DeleteDBInstance #

ToHeaders DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

ToPath DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

ToQuery DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

type Rep DeleteDBInstance Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

type Rep DeleteDBInstance = D1 ('MetaData "DeleteDBInstance" "Amazonka.RDS.DeleteDBInstance" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DeleteDBInstance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "finalDBSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deleteAutomatedBackups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (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.RDS.DeleteDBInstance

newDeleteDBInstance Source #

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 the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

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: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:skipFinalSnapshot:DeleteDBInstance', deleteDBInstance_skipFinalSnapshot - A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

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 skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

$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 the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

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_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_skipFinalSnapshot :: Lens' DeleteDBInstance (Maybe Bool) Source #

A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

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 skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

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

Read DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

Show DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

Generic DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

Associated Types

type Rep DeleteDBInstanceResponse :: Type -> Type #

NFData DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

type Rep DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBInstance

type Rep DeleteDBInstanceResponse = D1 ('MetaData "DeleteDBInstanceResponse" "Amazonka.RDS.DeleteDBInstance" "libZSservicesZSamazonka-rdsZSamazonka-rds" '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 #

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