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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

This action only applies to Amazon DocumentDB clusters.

Creating a Request

data DeleteGlobalCluster Source #

Represents the input to DeleteGlobalCluster.

See: newDeleteGlobalCluster smart constructor.

Constructors

DeleteGlobalCluster'
Fields globalClusterIdentifier :: Text The cluster identifier of the global cluster being deleted.

Instances

Instances details

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

newDeleteGlobalCluster Source #

Arguments

:: Text	`$sel:globalClusterIdentifier:DeleteGlobalCluster'`
-> DeleteGlobalCluster

Create a value of DeleteGlobalCluster 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:globalClusterIdentifier:DeleteGlobalCluster', deleteGlobalCluster_globalClusterIdentifier - The cluster identifier of the global cluster being deleted.

Request Lenses

deleteGlobalCluster_globalClusterIdentifier :: Lens' DeleteGlobalCluster Text Source #

The cluster identifier of the global cluster being deleted.

Destructuring the Response

data DeleteGlobalClusterResponse Source #

See: newDeleteGlobalClusterResponse smart constructor.

Constructors

DeleteGlobalClusterResponse'
Fields globalCluster :: Maybe GlobalCluster httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDeleteGlobalClusterResponse Source #

Arguments

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

Create a value of DeleteGlobalClusterResponse 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:globalCluster:DeleteGlobalClusterResponse', deleteGlobalClusterResponse_globalCluster - Undocumented member.

$sel:httpStatus:DeleteGlobalClusterResponse', deleteGlobalClusterResponse_httpStatus - The response's http status code.

Response Lenses

deleteGlobalClusterResponse_globalCluster :: Lens' DeleteGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

deleteGlobalClusterResponse_httpStatus :: Lens' DeleteGlobalClusterResponse Int Source #

The response's http status code.