Amazonka.DocumentDB.StopDBCluster

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Creating a Request

data StopDBCluster

See: newStopDBCluster smart constructor.

Constructors

StopDBCluster'

Fields

• dbClusterIdentifier :: Text

  The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

Instances

ToHeaders StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

toHeaders :: StopDBCluster -> [Header]

ToPath StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

toPath :: StopDBCluster -> ByteString

ToQuery StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

toQuery :: StopDBCluster -> QueryString

AWSRequest StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Associated Types

type AWSResponse StopDBCluster

Methods

request :: (Service -> Service) -> StopDBCluster -> Request StopDBCluster

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopDBCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopDBCluster)))

Generic StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Associated Types

type Rep StopDBCluster :: Type -> Type

Methods

from :: StopDBCluster -> Rep StopDBCluster x

to :: Rep StopDBCluster x -> StopDBCluster

Read StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

readsPrec :: Int -> ReadS StopDBCluster

readList :: ReadS [StopDBCluster]

readPrec :: ReadPrec StopDBCluster

readListPrec :: ReadPrec [StopDBCluster]

Show StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

showsPrec :: Int -> StopDBCluster -> ShowS

show :: StopDBCluster -> String

showList :: [StopDBCluster] -> ShowS

NFData StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

rnf :: StopDBCluster -> ()

Eq StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

(==) :: StopDBCluster -> StopDBCluster -> Bool

(/=) :: StopDBCluster -> StopDBCluster -> Bool

Hashable StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

hashWithSalt :: Int -> StopDBCluster -> Int

hash :: StopDBCluster -> Int

type AWSResponse StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

type AWSResponse StopDBCluster = StopDBClusterResponse

type Rep StopDBCluster

Defined in Amazonka.DocumentDB.StopDBCluster

type Rep StopDBCluster = D1 ('MetaData "StopDBCluster" "Amazonka.DocumentDB.StopDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "StopDBCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopDBCluster

Arguments

:: Text

StopDBCluster

-> StopDBCluster

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

StopDBCluster, stopDBCluster_dbClusterIdentifier - The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

Request Lenses

stopDBCluster_dbClusterIdentifier :: Lens' StopDBCluster Text

The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

Destructuring the Response

data StopDBClusterResponse

See: newStopDBClusterResponse smart constructor.

Constructors

StopDBClusterResponse'

Fields

• dbCluster :: Maybe DBCluster
• httpStatus :: Int

  The response's http status code.

Instances

Generic StopDBClusterResponse

Defined in Amazonka.DocumentDB.StopDBCluster

Associated Types

type Rep StopDBClusterResponse :: Type -> Type

Methods

from :: StopDBClusterResponse -> Rep StopDBClusterResponse x

to :: Rep StopDBClusterResponse x -> StopDBClusterResponse

Read StopDBClusterResponse

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

readsPrec :: Int -> ReadS StopDBClusterResponse

readList :: ReadS [StopDBClusterResponse]

readPrec :: ReadPrec StopDBClusterResponse

readListPrec :: ReadPrec [StopDBClusterResponse]

Show StopDBClusterResponse

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

showsPrec :: Int -> StopDBClusterResponse -> ShowS

show :: StopDBClusterResponse -> String

showList :: [StopDBClusterResponse] -> ShowS

NFData StopDBClusterResponse

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

rnf :: StopDBClusterResponse -> ()

Eq StopDBClusterResponse

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

(==) :: StopDBClusterResponse -> StopDBClusterResponse -> Bool

(/=) :: StopDBClusterResponse -> StopDBClusterResponse -> Bool

type Rep StopDBClusterResponse

Defined in Amazonka.DocumentDB.StopDBCluster

type Rep StopDBClusterResponse = D1 ('MetaData "StopDBClusterResponse" "Amazonka.DocumentDB.StopDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "StopDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopDBClusterResponse

Arguments

:: Int

$sel:httpStatus:StopDBClusterResponse'

-> StopDBClusterResponse

Create a value of StopDBClusterResponse 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:StopDBClusterResponse', stopDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:StopDBClusterResponse', stopDBClusterResponse_httpStatus - The response's http status code.

Response Lenses

stopDBClusterResponse_dbCluster :: Lens' StopDBClusterResponse (Maybe DBCluster)

Undocumented member.

stopDBClusterResponse_httpStatus :: Lens' StopDBClusterResponse Int

The response's http status code.