amazonka-docdb-elastic-2.0: Amazon DocumentDB Elastic Clusters SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DocDbElastic.CreateClusterSnapshot

Description

Creates a snapshot of a cluster.

Synopsis

Creating a Request

data CreateClusterSnapshot Source #

See: newCreateClusterSnapshot smart constructor.

Constructors

CreateClusterSnapshot' 

Fields

Instances

Instances details
ToJSON CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

ToHeaders CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

ToPath CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

ToQuery CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

AWSRequest CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

Associated Types

type AWSResponse CreateClusterSnapshot #

Generic CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

Associated Types

type Rep CreateClusterSnapshot :: Type -> Type #

Read CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

Show CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

NFData CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

Methods

rnf :: CreateClusterSnapshot -> () #

Eq CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

Hashable CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

type AWSResponse CreateClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

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 #

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

Instances

Instances details
Generic CreateClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

Associated Types

type Rep CreateClusterSnapshotResponse :: Type -> Type #

Read CreateClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

Show CreateClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

NFData CreateClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

Eq CreateClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocDbElastic.CreateClusterSnapshot

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 #

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_snapshot :: Lens' CreateClusterSnapshotResponse ClusterSnapshot Source #

Returns information about the new Elastic DocumentDB snapshot.