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.DocumentDB.CreateDBClusterSnapshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a snapshot of a cluster.

Synopsis

data CreateDBClusterSnapshot = CreateDBClusterSnapshot' {
- tags :: Maybe [Tag]
- dbClusterSnapshotIdentifier :: Text
- dbClusterIdentifier :: Text
}
newCreateDBClusterSnapshot :: Text -> Text -> CreateDBClusterSnapshot
createDBClusterSnapshot_tags :: Lens' CreateDBClusterSnapshot (Maybe [Tag])
createDBClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' CreateDBClusterSnapshot Text
createDBClusterSnapshot_dbClusterIdentifier :: Lens' CreateDBClusterSnapshot Text
data CreateDBClusterSnapshotResponse = CreateDBClusterSnapshotResponse' {
- dbClusterSnapshot :: Maybe DBClusterSnapshot
- httpStatus :: Int
}
newCreateDBClusterSnapshotResponse :: Int -> CreateDBClusterSnapshotResponse
createDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' CreateDBClusterSnapshotResponse (Maybe DBClusterSnapshot)
createDBClusterSnapshotResponse_httpStatus :: Lens' CreateDBClusterSnapshotResponse Int

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

ToHeaders CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods toHeaders :: CreateDBClusterSnapshot -> [Header] #
ToPath CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods toPath :: CreateDBClusterSnapshot -> ByteString #
ToQuery CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods toQuery :: CreateDBClusterSnapshot -> QueryString #
AWSRequest CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Associated Types type AWSResponse CreateDBClusterSnapshot # Methods request :: (Service -> Service) -> CreateDBClusterSnapshot -> Request CreateDBClusterSnapshot # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDBClusterSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDBClusterSnapshot))) #
Generic CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Associated Types type Rep CreateDBClusterSnapshot :: Type -> Type # Methods from :: CreateDBClusterSnapshot -> Rep CreateDBClusterSnapshot x # to :: Rep CreateDBClusterSnapshot x -> CreateDBClusterSnapshot #
Read CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods readsPrec :: Int -> ReadS CreateDBClusterSnapshot # readList :: ReadS [CreateDBClusterSnapshot] # readPrec :: ReadPrec CreateDBClusterSnapshot # readListPrec :: ReadPrec [CreateDBClusterSnapshot] #
Show CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods showsPrec :: Int -> CreateDBClusterSnapshot -> ShowS # show :: CreateDBClusterSnapshot -> String # showList :: [CreateDBClusterSnapshot] -> ShowS #
NFData CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods rnf :: CreateDBClusterSnapshot -> () #
Eq CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods (==) :: CreateDBClusterSnapshot -> CreateDBClusterSnapshot -> Bool # (/=) :: CreateDBClusterSnapshot -> CreateDBClusterSnapshot -> Bool #
Hashable CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods hashWithSalt :: Int -> CreateDBClusterSnapshot -> Int # hash :: CreateDBClusterSnapshot -> Int #
type AWSResponse CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot type AWSResponse CreateDBClusterSnapshot = CreateDBClusterSnapshotResponse
type Rep CreateDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot type Rep CreateDBClusterSnapshot = D1 ('MetaData "CreateDBClusterSnapshot" "Amazonka.DocumentDB.CreateDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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))))

newCreateDBClusterSnapshot Source #

Arguments

:: Text	`CreateDBClusterSnapshot`
-> Text	`CreateDBClusterSnapshot`
-> CreateDBClusterSnapshot

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.

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

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 dbClusterSnapshot :: Maybe DBClusterSnapshot httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Associated Types type Rep CreateDBClusterSnapshotResponse :: Type -> Type # Methods from :: CreateDBClusterSnapshotResponse -> Rep CreateDBClusterSnapshotResponse x # to :: Rep CreateDBClusterSnapshotResponse x -> CreateDBClusterSnapshotResponse #
Read CreateDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods readsPrec :: Int -> ReadS CreateDBClusterSnapshotResponse # readList :: ReadS [CreateDBClusterSnapshotResponse] # readPrec :: ReadPrec CreateDBClusterSnapshotResponse # readListPrec :: ReadPrec [CreateDBClusterSnapshotResponse] #
Show CreateDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods showsPrec :: Int -> CreateDBClusterSnapshotResponse -> ShowS # show :: CreateDBClusterSnapshotResponse -> String # showList :: [CreateDBClusterSnapshotResponse] -> ShowS #
NFData CreateDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods rnf :: CreateDBClusterSnapshotResponse -> () #
Eq CreateDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot Methods (==) :: CreateDBClusterSnapshotResponse -> CreateDBClusterSnapshotResponse -> Bool # (/=) :: CreateDBClusterSnapshotResponse -> CreateDBClusterSnapshotResponse -> Bool #
type Rep CreateDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot type Rep CreateDBClusterSnapshotResponse = D1 ('MetaData "CreateDBClusterSnapshotResponse" "Amazonka.DocumentDB.CreateDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 #

Arguments

:: Int	`$sel:httpStatus:CreateDBClusterSnapshotResponse'`
-> CreateDBClusterSnapshotResponse

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

createDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' CreateDBClusterSnapshotResponse (Maybe DBClusterSnapshot) Source #

Undocumented member.

createDBClusterSnapshotResponse_httpStatus :: Lens' CreateDBClusterSnapshotResponse Int Source #

The response's http status code.