libZSservicesZSamazonka-docdbZSamazonka-docdb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DocumentDB.CreateDBClusterSnapshot

Description

Creates a snapshot of a cluster.

Synopsis

Creating a Request

data CreateDBClusterSnapshot Source #

Represents the input of CreateDBClusterSnapshot.

See: newCreateDBClusterSnapshot smart constructor.

Constructors

CreateDBClusterSnapshot' 

Fields

  • tags :: Maybe [Tag]

    The tags to be assigned to the cluster snapshot.

  • dbClusterSnapshotIdentifier :: Text

    The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster-snapshot1

  • dbClusterIdentifier :: Text

    The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    Example: my-cluster

Instances

Instances details
Eq CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Read CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Show CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Generic CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Associated Types

type Rep CreateDBClusterSnapshot :: Type -> Type #

NFData CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Methods

rnf :: CreateDBClusterSnapshot -> () #

Hashable CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

AWSRequest CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

ToHeaders CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

ToPath CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

ToQuery CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

type Rep CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

type Rep CreateDBClusterSnapshot = D1 ('MetaData "CreateDBClusterSnapshot" "Amazonka.DocumentDB.CreateDBClusterSnapshot" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "CreateDBClusterSnapshot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

newCreateDBClusterSnapshot Source #

Create a value of CreateDBClusterSnapshot 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:CreateDBClusterSnapshot', createDBClusterSnapshot_tags - The tags to be assigned to the cluster snapshot.

$sel:dbClusterSnapshotIdentifier:CreateDBClusterSnapshot', createDBClusterSnapshot_dbClusterSnapshotIdentifier - The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

$sel:dbClusterIdentifier:CreateDBClusterSnapshot', createDBClusterSnapshot_dbClusterIdentifier - The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster

Request Lenses

createDBClusterSnapshot_tags :: Lens' CreateDBClusterSnapshot (Maybe [Tag]) Source #

The tags to be assigned to the cluster snapshot.

createDBClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' CreateDBClusterSnapshot Text Source #

The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

createDBClusterSnapshot_dbClusterIdentifier :: Lens' CreateDBClusterSnapshot Text Source #

The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster

Destructuring the Response

data CreateDBClusterSnapshotResponse Source #

See: newCreateDBClusterSnapshotResponse smart constructor.

Constructors

CreateDBClusterSnapshotResponse' 

Fields

Instances

Instances details
Eq CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Read CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Show CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Generic CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Associated Types

type Rep CreateDBClusterSnapshotResponse :: Type -> Type #

NFData CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

type Rep CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

type Rep CreateDBClusterSnapshotResponse = D1 ('MetaData "CreateDBClusterSnapshotResponse" "Amazonka.DocumentDB.CreateDBClusterSnapshot" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "CreateDBClusterSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBClusterSnapshotResponse Source #

Create a value of CreateDBClusterSnapshotResponse 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:dbClusterSnapshot:CreateDBClusterSnapshotResponse', createDBClusterSnapshotResponse_dbClusterSnapshot - Undocumented member.

$sel:httpStatus:CreateDBClusterSnapshotResponse', createDBClusterSnapshotResponse_httpStatus - The response's http status code.

Response Lenses