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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a snapshot of a cluster.

Creating a Request

data CreateClusterSnapshot Source #

See: newCreateClusterSnapshot smart constructor.

Constructors

CreateClusterSnapshot'
Fields tags :: Maybe (HashMap Text Text) The tags to be assigned to the new Elastic DocumentDB snapshot. clusterArn :: Text The arn of the Elastic DocumentDB cluster that the snapshot will be taken from. snapshotName :: Text The name of the Elastic DocumentDB snapshot.

Instances

Instances details

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

newCreateClusterSnapshot Source #

Arguments

:: Text	`CreateClusterSnapshot`
-> Text	`CreateClusterSnapshot`
-> CreateClusterSnapshot

Create a value of CreateClusterSnapshot 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:tags:CreateClusterSnapshot', createClusterSnapshot_tags - The tags to be assigned to the new Elastic DocumentDB snapshot.

CreateClusterSnapshot, createClusterSnapshot_clusterArn - The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.

CreateClusterSnapshot, createClusterSnapshot_snapshotName - The name of the Elastic DocumentDB snapshot.

Request Lenses

createClusterSnapshot_tags :: Lens' CreateClusterSnapshot (Maybe (HashMap Text Text)) Source #

The tags to be assigned to the new Elastic DocumentDB snapshot.

createClusterSnapshot_clusterArn :: Lens' CreateClusterSnapshot Text Source #

The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.

createClusterSnapshot_snapshotName :: Lens' CreateClusterSnapshot Text Source #

The name of the Elastic DocumentDB snapshot.

Destructuring the Response

data CreateClusterSnapshotResponse Source #

See: newCreateClusterSnapshotResponse smart constructor.

Constructors

CreateClusterSnapshotResponse'
Fields httpStatus :: Int The response's http status code. snapshot :: ClusterSnapshot Returns information about the new Elastic DocumentDB snapshot.

Instances

Instances details

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

newCreateClusterSnapshotResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateClusterSnapshotResponse'`
-> ClusterSnapshot	`$sel:snapshot:CreateClusterSnapshotResponse'`
-> CreateClusterSnapshotResponse

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

$sel:snapshot:CreateClusterSnapshotResponse', createClusterSnapshotResponse_snapshot - Returns information about the new Elastic DocumentDB snapshot.

Response Lenses

createClusterSnapshotResponse_httpStatus :: Lens' CreateClusterSnapshotResponse Int Source #

The response's http status code.

createClusterSnapshotResponse_snapshot :: Lens' CreateClusterSnapshotResponse ClusterSnapshot Source #

Returns information about the new Elastic DocumentDB snapshot.