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.DocDbElastic.DeleteCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Delete a Elastic DocumentDB cluster.

Synopsis

Creating a Request

data DeleteCluster Source #

See: newDeleteCluster smart constructor.

Constructors

DeleteCluster'
Fields clusterArn :: Text The arn of the Elastic DocumentDB cluster that is to be deleted.

Instances

Instances details

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

newDeleteCluster Source #

Arguments

:: Text	`DeleteCluster`
-> DeleteCluster

Create a value of DeleteCluster 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:

DeleteCluster, deleteCluster_clusterArn - The arn of the Elastic DocumentDB cluster that is to be deleted.

Request Lenses

deleteCluster_clusterArn :: Lens' DeleteCluster Text Source #

The arn of the Elastic DocumentDB cluster that is to be deleted.

Destructuring the Response

data DeleteClusterResponse Source #

See: newDeleteClusterResponse smart constructor.

Constructors

DeleteClusterResponse'
Fields httpStatus :: Int The response's http status code. cluster :: Cluster Returns information about the newly deleted Elastic DocumentDB cluster.

Instances

Instances details

Generic DeleteClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.DeleteCluster Associated Types type Rep DeleteClusterResponse :: Type -> Type # Methods from :: DeleteClusterResponse -> Rep DeleteClusterResponse x # to :: Rep DeleteClusterResponse x -> DeleteClusterResponse #
Read DeleteClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.DeleteCluster Methods readsPrec :: Int -> ReadS DeleteClusterResponse # readList :: ReadS [DeleteClusterResponse] # readPrec :: ReadPrec DeleteClusterResponse # readListPrec :: ReadPrec [DeleteClusterResponse] #
Show DeleteClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.DeleteCluster Methods showsPrec :: Int -> DeleteClusterResponse -> ShowS # show :: DeleteClusterResponse -> String # showList :: [DeleteClusterResponse] -> ShowS #
NFData DeleteClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.DeleteCluster Methods rnf :: DeleteClusterResponse -> () #
Eq DeleteClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.DeleteCluster Methods (==) :: DeleteClusterResponse -> DeleteClusterResponse -> Bool # (/=) :: DeleteClusterResponse -> DeleteClusterResponse -> Bool #
type Rep DeleteClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.DeleteCluster type Rep DeleteClusterResponse = D1 ('MetaData "DeleteClusterResponse" "Amazonka.DocDbElastic.DeleteCluster" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "DeleteClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Cluster)))

newDeleteClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteClusterResponse'`
-> Cluster	`$sel:cluster:DeleteClusterResponse'`
-> DeleteClusterResponse

Create a value of DeleteClusterResponse 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:httpStatus:DeleteClusterResponse', deleteClusterResponse_httpStatus - The response's http status code.

$sel:cluster:DeleteClusterResponse', deleteClusterResponse_cluster - Returns information about the newly deleted Elastic DocumentDB cluster.

Response Lenses

deleteClusterResponse_httpStatus :: Lens' DeleteClusterResponse Int Source #

The response's http status code.

deleteClusterResponse_cluster :: Lens' DeleteClusterResponse Cluster Source #

Returns information about the newly deleted Elastic DocumentDB cluster.