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

Description

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.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Synopsis

Creating a Request

data DeleteDBCluster Source #

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

    Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.
    • First character must be a letter
    • Can't end with a hyphen or contain two consecutive hyphens
  • skipFinalSnapshot :: Maybe Bool

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

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

  • 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

Instances details
Eq DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

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

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

Read DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

readsPrec :: Int -> ReadS DeleteDBCluster #

readList :: ReadS [DeleteDBCluster] #

readPrec :: ReadPrec DeleteDBCluster #

readListPrec :: ReadPrec [DeleteDBCluster] #

Show DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

showsPrec :: Int -> DeleteDBCluster -> ShowS #

show :: DeleteDBCluster -> String #

showList :: [DeleteDBCluster] -> ShowS #

Generic DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Associated Types

type Rep DeleteDBCluster :: Type -> Type #

Methods

from :: DeleteDBCluster -> Rep DeleteDBCluster x #

to :: Rep DeleteDBCluster x -> DeleteDBCluster #

NFData DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

rnf :: DeleteDBCluster -> () #

Hashable DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

hashWithSalt :: Int -> DeleteDBCluster -> Int #

hash :: DeleteDBCluster -> Int #

AWSRequest DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Associated Types

type AWSResponse DeleteDBCluster #

Methods

request :: DeleteDBCluster -> Request DeleteDBCluster #

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

ToHeaders DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

toHeaders :: DeleteDBCluster -> [Header] #

ToPath DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

toPath :: DeleteDBCluster -> ByteString #

ToQuery DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

toQuery :: DeleteDBCluster -> QueryString #

type Rep DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

type Rep DeleteDBCluster = D1 ('MetaData "DeleteDBCluster" "Amazonka.RDS.DeleteDBCluster" "libZSservicesZSamazonka-rdsZSamazonka-rds" '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))))
type AWSResponse DeleteDBCluster Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

type AWSResponse DeleteDBCluster = DeleteDBClusterResponse

newDeleteDBCluster Source #

Arguments

:: Text

$sel:dbClusterIdentifier: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 disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens

$sel:skipFinalSnapshot:DeleteDBCluster', deleteDBCluster_skipFinalSnapshot - A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

$sel:dbClusterIdentifier: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) Source #

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens

deleteDBCluster_skipFinalSnapshot :: Lens' DeleteDBCluster (Maybe Bool) Source #

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

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

deleteDBCluster_dbClusterIdentifier :: Lens' DeleteDBCluster Text Source #

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 Source #

See: newDeleteDBClusterResponse smart constructor.

Constructors

DeleteDBClusterResponse' 

Fields

Instances

Instances details
Eq DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

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

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

Read DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

readsPrec :: Int -> ReadS DeleteDBClusterResponse #

readList :: ReadS [DeleteDBClusterResponse] #

readPrec :: ReadPrec DeleteDBClusterResponse #

readListPrec :: ReadPrec [DeleteDBClusterResponse] #

Show DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

showsPrec :: Int -> DeleteDBClusterResponse -> ShowS #

show :: DeleteDBClusterResponse -> String #

showList :: [DeleteDBClusterResponse] -> ShowS #

Generic DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Associated Types

type Rep DeleteDBClusterResponse :: Type -> Type #

Methods

from :: DeleteDBClusterResponse -> Rep DeleteDBClusterResponse x #

to :: Rep DeleteDBClusterResponse x -> DeleteDBClusterResponse #

NFData DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

Methods

rnf :: DeleteDBClusterResponse -> () #

type Rep DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.DeleteDBCluster

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

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) Source #

Undocumented member.

deleteDBClusterResponse_httpStatus :: Lens' DeleteDBClusterResponse Int Source #

The response's http status code.