Amazonka.Neptune.DeleteDBCluster

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its DeletionProtection field to False.

Creating a Request

data DeleteDBCluster

See: newDeleteDBCluster smart constructor.

Constructors

DeleteDBCluster'

Fields

• finalDBSnapshotIdentifier :: Maybe Text

  The DB cluster snapshot identifier of the new DB cluster snapshot 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, numbers, or hyphens.
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
• skipFinalSnapshot :: Maybe Bool

  Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

  You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

  Default: false

• dbClusterIdentifier :: Text

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

  Constraints:

  • Must match an existing DBClusterIdentifier.

Instances

ToHeaders DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

toHeaders :: DeleteDBCluster -> [Header]

ToPath DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

toPath :: DeleteDBCluster -> ByteString

ToQuery DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

toQuery :: DeleteDBCluster -> QueryString

AWSRequest DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Associated Types

type AWSResponse DeleteDBCluster

Methods

request :: (Service -> Service) -> DeleteDBCluster -> Request DeleteDBCluster

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteDBCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDBCluster)))

Generic DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Associated Types

type Rep DeleteDBCluster :: Type -> Type

Methods

from :: DeleteDBCluster -> Rep DeleteDBCluster x

to :: Rep DeleteDBCluster x -> DeleteDBCluster

Read DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

readsPrec :: Int -> ReadS DeleteDBCluster

readList :: ReadS [DeleteDBCluster]

readPrec :: ReadPrec DeleteDBCluster

readListPrec :: ReadPrec [DeleteDBCluster]

Show DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

showsPrec :: Int -> DeleteDBCluster -> ShowS

show :: DeleteDBCluster -> String

showList :: [DeleteDBCluster] -> ShowS

NFData DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

rnf :: DeleteDBCluster -> ()

Eq DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

(==) :: DeleteDBCluster -> DeleteDBCluster -> Bool

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

Hashable DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

hashWithSalt :: Int -> DeleteDBCluster -> Int

hash :: DeleteDBCluster -> Int

type AWSResponse DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

type AWSResponse DeleteDBCluster = DeleteDBClusterResponse

type Rep DeleteDBCluster

Defined in Amazonka.Neptune.DeleteDBCluster

type Rep DeleteDBCluster = D1 ('MetaData "DeleteDBCluster" "Amazonka.Neptune.DeleteDBCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "DeleteDBCluster'" '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 "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteDBCluster

Arguments

:: Text

DeleteDBCluster

-> DeleteDBCluster

Create a value of DeleteDBCluster 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:DeleteDBCluster', deleteDBCluster_finalDBSnapshotIdentifier - The DB cluster snapshot identifier of the new DB cluster snapshot 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, numbers, or hyphens.
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

$sel:skipFinalSnapshot:DeleteDBCluster', deleteDBCluster_skipFinalSnapshot - Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

Default: false

DeleteDBCluster, deleteDBCluster_dbClusterIdentifier - The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

Constraints:

• Must match an existing DBClusterIdentifier.

Request Lenses

deleteDBCluster_finalDBSnapshotIdentifier :: Lens' DeleteDBCluster (Maybe Text)

The DB cluster snapshot identifier of the new DB cluster snapshot 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, numbers, or hyphens.
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

deleteDBCluster_skipFinalSnapshot :: Lens' DeleteDBCluster (Maybe Bool)

Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

Default: false

deleteDBCluster_dbClusterIdentifier :: Lens' DeleteDBCluster Text

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

Constraints:

• Must match an existing DBClusterIdentifier.

Destructuring the Response

data DeleteDBClusterResponse

See: newDeleteDBClusterResponse smart constructor.

Constructors

DeleteDBClusterResponse'

Fields

• dbCluster :: Maybe DBCluster
• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteDBClusterResponse

Defined in Amazonka.Neptune.DeleteDBCluster

Associated Types

type Rep DeleteDBClusterResponse :: Type -> Type

Methods

from :: DeleteDBClusterResponse -> Rep DeleteDBClusterResponse x

to :: Rep DeleteDBClusterResponse x -> DeleteDBClusterResponse

Read DeleteDBClusterResponse

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

readsPrec :: Int -> ReadS DeleteDBClusterResponse

readList :: ReadS [DeleteDBClusterResponse]

readPrec :: ReadPrec DeleteDBClusterResponse

readListPrec :: ReadPrec [DeleteDBClusterResponse]

Show DeleteDBClusterResponse

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

showsPrec :: Int -> DeleteDBClusterResponse -> ShowS

show :: DeleteDBClusterResponse -> String

showList :: [DeleteDBClusterResponse] -> ShowS

NFData DeleteDBClusterResponse

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

rnf :: DeleteDBClusterResponse -> ()

Eq DeleteDBClusterResponse

Defined in Amazonka.Neptune.DeleteDBCluster

Methods

(==) :: DeleteDBClusterResponse -> DeleteDBClusterResponse -> Bool

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

type Rep DeleteDBClusterResponse

Defined in Amazonka.Neptune.DeleteDBCluster

type Rep DeleteDBClusterResponse = D1 ('MetaData "DeleteDBClusterResponse" "Amazonka.Neptune.DeleteDBCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "DeleteDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteDBClusterResponse

Arguments

:: Int

$sel:httpStatus:DeleteDBClusterResponse'

-> DeleteDBClusterResponse

Create a value of DeleteDBClusterResponse 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:dbCluster:DeleteDBClusterResponse', deleteDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:DeleteDBClusterResponse', deleteDBClusterResponse_httpStatus - The response's http status code.

Response Lenses

deleteDBClusterResponse_dbCluster :: Lens' DeleteDBClusterResponse (Maybe DBCluster)

Undocumented member.

deleteDBClusterResponse_httpStatus :: Lens' DeleteDBClusterResponse Int

The response's http status code.