Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DocumentDB.DeleteDBCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DeleteDBCluster Source #

Represents the input to DeleteDBCluster.

See: newDeleteDBCluster smart constructor.

Constructors

DeleteDBCluster'

Fields

finalDBSnapshotIdentifier :: Maybe Text
The cluster snapshot identifier of the new 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 from 1 to 255 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
skipFinalSnapshot :: Maybe Bool
Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.
If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.
Default: false
dbClusterIdentifier :: Text
The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
Constraints:
- Must match an existing DBClusterIdentifier.

Instances

Instances details

ToHeaders DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods toHeaders :: DeleteDBCluster -> [Header] #
ToPath DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods toPath :: DeleteDBCluster -> ByteString #
ToQuery DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods toQuery :: DeleteDBCluster -> QueryString #
AWSRequest DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.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 Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Associated Types type Rep DeleteDBCluster :: Type -> Type # Methods from :: DeleteDBCluster -> Rep DeleteDBCluster x # to :: Rep DeleteDBCluster x -> DeleteDBCluster #
Read DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods readsPrec :: Int -> ReadS DeleteDBCluster # readList :: ReadS [DeleteDBCluster] # readPrec :: ReadPrec DeleteDBCluster # readListPrec :: ReadPrec [DeleteDBCluster] #
Show DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods showsPrec :: Int -> DeleteDBCluster -> ShowS # show :: DeleteDBCluster -> String # showList :: [DeleteDBCluster] -> ShowS #
NFData DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods rnf :: DeleteDBCluster -> () #
Eq DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods (==) :: DeleteDBCluster -> DeleteDBCluster -> Bool # (/=) :: DeleteDBCluster -> DeleteDBCluster -> Bool #
Hashable DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods hashWithSalt :: Int -> DeleteDBCluster -> Int # hash :: DeleteDBCluster -> Int #
type AWSResponse DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster type AWSResponse DeleteDBCluster = DeleteDBClusterResponse
type Rep DeleteDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster type Rep DeleteDBCluster = D1 ('MetaData "DeleteDBCluster" "Amazonka.DocumentDB.DeleteDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 Source #

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 cluster snapshot identifier of the new 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 from 1 to 255 letters, numbers, or hyphens.
The 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 cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

DeleteDBCluster, deleteDBCluster_dbClusterIdentifier - The cluster identifier for the 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 cluster snapshot identifier of the new 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 from 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

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

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

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

deleteDBCluster_dbClusterIdentifier :: Lens' DeleteDBCluster Text Source #

The cluster identifier for the 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 dbCluster :: Maybe DBCluster httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Associated Types type Rep DeleteDBClusterResponse :: Type -> Type # Methods from :: DeleteDBClusterResponse -> Rep DeleteDBClusterResponse x # to :: Rep DeleteDBClusterResponse x -> DeleteDBClusterResponse #
Read DeleteDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods readsPrec :: Int -> ReadS DeleteDBClusterResponse # readList :: ReadS [DeleteDBClusterResponse] # readPrec :: ReadPrec DeleteDBClusterResponse # readListPrec :: ReadPrec [DeleteDBClusterResponse] #
Show DeleteDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods showsPrec :: Int -> DeleteDBClusterResponse -> ShowS # show :: DeleteDBClusterResponse -> String # showList :: [DeleteDBClusterResponse] -> ShowS #
NFData DeleteDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods rnf :: DeleteDBClusterResponse -> () #
Eq DeleteDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster Methods (==) :: DeleteDBClusterResponse -> DeleteDBClusterResponse -> Bool # (/=) :: DeleteDBClusterResponse -> DeleteDBClusterResponse -> Bool #
type Rep DeleteDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBCluster type Rep DeleteDBClusterResponse = D1 ('MetaData "DeleteDBClusterResponse" "Amazonka.DocumentDB.DeleteDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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.