Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.DeleteDBClusterSnapshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The cluster snapshot must be in the available state to be deleted.

Creating a Request

data DeleteDBClusterSnapshot Source #

Represents the input to DeleteDBClusterSnapshot.

See: newDeleteDBClusterSnapshot smart constructor.

Constructors

DeleteDBClusterSnapshot'
Fields dbClusterSnapshotIdentifier :: Text The identifier of the cluster snapshot to delete. Constraints: Must be the name of an existing cluster snapshot in the `available` state.

Instances

Instances details

Eq DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods (==) :: DeleteDBClusterSnapshot -> DeleteDBClusterSnapshot -> Bool # (/=) :: DeleteDBClusterSnapshot -> DeleteDBClusterSnapshot -> Bool #
Read DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods readsPrec :: Int -> ReadS DeleteDBClusterSnapshot # readList :: ReadS [DeleteDBClusterSnapshot] # readPrec :: ReadPrec DeleteDBClusterSnapshot # readListPrec :: ReadPrec [DeleteDBClusterSnapshot] #
Show DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods showsPrec :: Int -> DeleteDBClusterSnapshot -> ShowS # show :: DeleteDBClusterSnapshot -> String # showList :: [DeleteDBClusterSnapshot] -> ShowS #
Generic DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Associated Types type Rep DeleteDBClusterSnapshot :: Type -> Type # Methods from :: DeleteDBClusterSnapshot -> Rep DeleteDBClusterSnapshot x # to :: Rep DeleteDBClusterSnapshot x -> DeleteDBClusterSnapshot #
NFData DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods rnf :: DeleteDBClusterSnapshot -> () #
Hashable DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods hashWithSalt :: Int -> DeleteDBClusterSnapshot -> Int # hash :: DeleteDBClusterSnapshot -> Int #
AWSRequest DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Associated Types type AWSResponse DeleteDBClusterSnapshot # Methods request :: DeleteDBClusterSnapshot -> Request DeleteDBClusterSnapshot # response :: MonadResource m => Logger -> Service -> Proxy DeleteDBClusterSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDBClusterSnapshot))) #
ToHeaders DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods toHeaders :: DeleteDBClusterSnapshot -> [Header] #
ToPath DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods toPath :: DeleteDBClusterSnapshot -> ByteString #
ToQuery DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods toQuery :: DeleteDBClusterSnapshot -> QueryString #
type Rep DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot type Rep DeleteDBClusterSnapshot = D1 ('MetaData "DeleteDBClusterSnapshot" "Amazonka.DocumentDB.DeleteDBClusterSnapshot" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DeleteDBClusterSnapshot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot type AWSResponse DeleteDBClusterSnapshot = DeleteDBClusterSnapshotResponse

newDeleteDBClusterSnapshot Source #

Arguments

:: Text	`$sel:dbClusterSnapshotIdentifier:DeleteDBClusterSnapshot'`
-> DeleteDBClusterSnapshot

Create a value of DeleteDBClusterSnapshot 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:dbClusterSnapshotIdentifier:DeleteDBClusterSnapshot', deleteDBClusterSnapshot_dbClusterSnapshotIdentifier - The identifier of the cluster snapshot to delete.

Constraints: Must be the name of an existing cluster snapshot in the available state.

Request Lenses

deleteDBClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DeleteDBClusterSnapshot Text Source #

The identifier of the cluster snapshot to delete.

Constraints: Must be the name of an existing cluster snapshot in the available state.

Destructuring the Response

data DeleteDBClusterSnapshotResponse Source #

See: newDeleteDBClusterSnapshotResponse smart constructor.

Constructors

DeleteDBClusterSnapshotResponse'
Fields dbClusterSnapshot :: Maybe DBClusterSnapshot httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods (==) :: DeleteDBClusterSnapshotResponse -> DeleteDBClusterSnapshotResponse -> Bool # (/=) :: DeleteDBClusterSnapshotResponse -> DeleteDBClusterSnapshotResponse -> Bool #
Read DeleteDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods readsPrec :: Int -> ReadS DeleteDBClusterSnapshotResponse # readList :: ReadS [DeleteDBClusterSnapshotResponse] # readPrec :: ReadPrec DeleteDBClusterSnapshotResponse # readListPrec :: ReadPrec [DeleteDBClusterSnapshotResponse] #
Show DeleteDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods showsPrec :: Int -> DeleteDBClusterSnapshotResponse -> ShowS # show :: DeleteDBClusterSnapshotResponse -> String # showList :: [DeleteDBClusterSnapshotResponse] -> ShowS #
Generic DeleteDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Associated Types type Rep DeleteDBClusterSnapshotResponse :: Type -> Type # Methods from :: DeleteDBClusterSnapshotResponse -> Rep DeleteDBClusterSnapshotResponse x # to :: Rep DeleteDBClusterSnapshotResponse x -> DeleteDBClusterSnapshotResponse #
NFData DeleteDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot Methods rnf :: DeleteDBClusterSnapshotResponse -> () #
type Rep DeleteDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot type Rep DeleteDBClusterSnapshotResponse = D1 ('MetaData "DeleteDBClusterSnapshotResponse" "Amazonka.DocumentDB.DeleteDBClusterSnapshot" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DeleteDBClusterSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteDBClusterSnapshotResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteDBClusterSnapshotResponse'`
-> DeleteDBClusterSnapshotResponse

Create a value of DeleteDBClusterSnapshotResponse 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:dbClusterSnapshot:DeleteDBClusterSnapshotResponse', deleteDBClusterSnapshotResponse_dbClusterSnapshot - Undocumented member.

$sel:httpStatus:DeleteDBClusterSnapshotResponse', deleteDBClusterSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

deleteDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' DeleteDBClusterSnapshotResponse (Maybe DBClusterSnapshot) Source #

Undocumented member.

deleteDBClusterSnapshotResponse_httpStatus :: Lens' DeleteDBClusterSnapshotResponse Int Source #

The response's http status code.