Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Neptune.CopyDBClusterSnapshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

Synopsis

Creating a Request

data CopyDBClusterSnapshot Source #

See: newCopyDBClusterSnapshot smart constructor.

Constructors

CopyDBClusterSnapshot'

Fields

preSignedUrl :: Maybe Text
Not currently supported.
copyTags :: Maybe Bool
True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.
kmsKeyId :: Maybe Text
The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.
KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.
You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
tags :: Maybe [Tag]
The tags to assign to the new DB cluster snapshot copy.
sourceDBClusterSnapshotIdentifier :: Text
The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.
Constraints:
- Must specify a valid system snapshot in the "available" state.
- Specify a valid DB snapshot identifier.
Example: my-cluster-snapshot1
targetDBClusterSnapshotIdentifier :: Text
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2

Instances

Instances details

Eq CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods (==) :: CopyDBClusterSnapshot -> CopyDBClusterSnapshot -> Bool # (/=) :: CopyDBClusterSnapshot -> CopyDBClusterSnapshot -> Bool #
Read CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods readsPrec :: Int -> ReadS CopyDBClusterSnapshot # readList :: ReadS [CopyDBClusterSnapshot] # readPrec :: ReadPrec CopyDBClusterSnapshot # readListPrec :: ReadPrec [CopyDBClusterSnapshot] #
Show CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods showsPrec :: Int -> CopyDBClusterSnapshot -> ShowS # show :: CopyDBClusterSnapshot -> String # showList :: [CopyDBClusterSnapshot] -> ShowS #
Generic CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Associated Types type Rep CopyDBClusterSnapshot :: Type -> Type # Methods from :: CopyDBClusterSnapshot -> Rep CopyDBClusterSnapshot x # to :: Rep CopyDBClusterSnapshot x -> CopyDBClusterSnapshot #
NFData CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods rnf :: CopyDBClusterSnapshot -> () #
Hashable CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods hashWithSalt :: Int -> CopyDBClusterSnapshot -> Int # hash :: CopyDBClusterSnapshot -> Int #
AWSRequest CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Associated Types type AWSResponse CopyDBClusterSnapshot # Methods request :: CopyDBClusterSnapshot -> Request CopyDBClusterSnapshot # response :: MonadResource m => Logger -> Service -> Proxy CopyDBClusterSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CopyDBClusterSnapshot))) #
ToHeaders CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods toHeaders :: CopyDBClusterSnapshot -> [Header] #
ToPath CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods toPath :: CopyDBClusterSnapshot -> ByteString #
ToQuery CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods toQuery :: CopyDBClusterSnapshot -> QueryString #
type Rep CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot type Rep CopyDBClusterSnapshot = D1 ('MetaData "CopyDBClusterSnapshot" "Amazonka.Neptune.CopyDBClusterSnapshot" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "CopyDBClusterSnapshot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "preSignedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "copyTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "sourceDBClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetDBClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot type AWSResponse CopyDBClusterSnapshot = CopyDBClusterSnapshotResponse

newCopyDBClusterSnapshot Source #

Arguments

:: Text	`$sel:sourceDBClusterSnapshotIdentifier:CopyDBClusterSnapshot'`
-> Text	`$sel:targetDBClusterSnapshotIdentifier:CopyDBClusterSnapshot'`
-> CopyDBClusterSnapshot

Create a value of CopyDBClusterSnapshot 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:preSignedUrl:CopyDBClusterSnapshot', copyDBClusterSnapshot_preSignedUrl - Not currently supported.

$sel:copyTags:CopyDBClusterSnapshot', copyDBClusterSnapshot_copyTags - True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

$sel:kmsKeyId:CopyDBClusterSnapshot', copyDBClusterSnapshot_kmsKeyId - The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

$sel:tags:CopyDBClusterSnapshot', copyDBClusterSnapshot_tags - The tags to assign to the new DB cluster snapshot copy.

$sel:sourceDBClusterSnapshotIdentifier:CopyDBClusterSnapshot', copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier - The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

Must specify a valid system snapshot in the "available" state.
Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

$sel:targetDBClusterSnapshotIdentifier:CopyDBClusterSnapshot', copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier - The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

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

Example: my-cluster-snapshot2

Request Lenses

copyDBClusterSnapshot_preSignedUrl :: Lens' CopyDBClusterSnapshot (Maybe Text) Source #

Not currently supported.

copyDBClusterSnapshot_copyTags :: Lens' CopyDBClusterSnapshot (Maybe Bool) Source #

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

copyDBClusterSnapshot_kmsKeyId :: Lens' CopyDBClusterSnapshot (Maybe Text) Source #

The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

copyDBClusterSnapshot_tags :: Lens' CopyDBClusterSnapshot (Maybe [Tag]) Source #

The tags to assign to the new DB cluster snapshot copy.

copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text Source #

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

Must specify a valid system snapshot in the "available" state.
Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text Source #

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

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

Example: my-cluster-snapshot2

Destructuring the Response

data CopyDBClusterSnapshotResponse Source #

See: newCopyDBClusterSnapshotResponse smart constructor.

Constructors

CopyDBClusterSnapshotResponse'
Fields dbClusterSnapshot :: Maybe DBClusterSnapshot httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods (==) :: CopyDBClusterSnapshotResponse -> CopyDBClusterSnapshotResponse -> Bool # (/=) :: CopyDBClusterSnapshotResponse -> CopyDBClusterSnapshotResponse -> Bool #
Read CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods readsPrec :: Int -> ReadS CopyDBClusterSnapshotResponse # readList :: ReadS [CopyDBClusterSnapshotResponse] # readPrec :: ReadPrec CopyDBClusterSnapshotResponse # readListPrec :: ReadPrec [CopyDBClusterSnapshotResponse] #
Show CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods showsPrec :: Int -> CopyDBClusterSnapshotResponse -> ShowS # show :: CopyDBClusterSnapshotResponse -> String # showList :: [CopyDBClusterSnapshotResponse] -> ShowS #
Generic CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Associated Types type Rep CopyDBClusterSnapshotResponse :: Type -> Type # Methods from :: CopyDBClusterSnapshotResponse -> Rep CopyDBClusterSnapshotResponse x # to :: Rep CopyDBClusterSnapshotResponse x -> CopyDBClusterSnapshotResponse #
NFData CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot Methods rnf :: CopyDBClusterSnapshotResponse -> () #
type Rep CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.Neptune.CopyDBClusterSnapshot type Rep CopyDBClusterSnapshotResponse = D1 ('MetaData "CopyDBClusterSnapshotResponse" "Amazonka.Neptune.CopyDBClusterSnapshot" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "CopyDBClusterSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCopyDBClusterSnapshotResponse Source #

Arguments

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

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

$sel:httpStatus:CopyDBClusterSnapshotResponse', copyDBClusterSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

copyDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' CopyDBClusterSnapshotResponse (Maybe DBClusterSnapshot) Source #

Undocumented member.

copyDBClusterSnapshotResponse_httpStatus :: Lens' CopyDBClusterSnapshotResponse Int Source #

The response's http status code.