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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Region.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

Synopsis

Creating a Request

data CopyDBClusterSnapshot Source #

Represents the input to CopyDBClusterSnapshot.

See: newCopyDBClusterSnapshot smart constructor.

Constructors

CopyDBClusterSnapshot'

Fields

preSignedUrl :: Maybe Text
The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:
- SourceRegion - The ID of the region that contains the snapshot to be copied.
- SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
- TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.
copyTags :: Maybe Bool
Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.
kmsKeyId :: Maybe Text
The KMS key ID for an encrypted 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 cluster snapshot from your 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 cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.
If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.
To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.
If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
tags :: Maybe [Tag]
The tags to be assigned to the cluster snapshot.
sourceDBClusterSnapshotIdentifier :: Text
The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
Constraints:
- Must specify a valid system snapshot in the available state.
- If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.
- If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.
Example: my-cluster-snapshot1
targetDBClusterSnapshotIdentifier :: Text
The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.
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-snapshot2

Instances

Instances details

Eq CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot Methods (==) :: CopyDBClusterSnapshot -> CopyDBClusterSnapshot -> Bool # (/=) :: CopyDBClusterSnapshot -> CopyDBClusterSnapshot -> Bool #
Read CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot Methods readsPrec :: Int -> ReadS CopyDBClusterSnapshot # readList :: ReadS [CopyDBClusterSnapshot] # readPrec :: ReadPrec CopyDBClusterSnapshot # readListPrec :: ReadPrec [CopyDBClusterSnapshot] #
Show CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot Methods showsPrec :: Int -> CopyDBClusterSnapshot -> ShowS # show :: CopyDBClusterSnapshot -> String # showList :: [CopyDBClusterSnapshot] -> ShowS #
Generic CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.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.DocumentDB.CopyDBClusterSnapshot Methods rnf :: CopyDBClusterSnapshot -> () #
Hashable CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot Methods hashWithSalt :: Int -> CopyDBClusterSnapshot -> Int # hash :: CopyDBClusterSnapshot -> Int #
AWSRequest CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.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.DocumentDB.CopyDBClusterSnapshot Methods toHeaders :: CopyDBClusterSnapshot -> [Header] #
ToPath CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot Methods toPath :: CopyDBClusterSnapshot -> ByteString #
ToQuery CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot Methods toQuery :: CopyDBClusterSnapshot -> QueryString #
type Rep CopyDBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot type Rep CopyDBClusterSnapshot = D1 ('MetaData "CopyDBClusterSnapshot" "Amazonka.DocumentDB.CopyDBClusterSnapshot" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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.DocumentDB.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 - The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

SourceRegion - The ID of the region that contains the snapshot to be copied.
SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

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

$sel:kmsKeyId:CopyDBClusterSnapshot', copyDBClusterSnapshot_kmsKeyId - The KMS key ID for an encrypted 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 cluster snapshot from your 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 cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

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

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

$sel:tags:CopyDBClusterSnapshot', copyDBClusterSnapshot_tags - The tags to be assigned to the cluster snapshot.

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

Constraints:

Must specify a valid system snapshot in the available state.
If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.
If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

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

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-snapshot2

Request Lenses

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

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

SourceRegion - The ID of the region that contains the snapshot to be copied.
SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

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

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

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

The KMS key ID for an encrypted 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 cluster snapshot from your 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 cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

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

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

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

The tags to be assigned to the cluster snapshot.

copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text Source #

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

Constraints:

Must specify a valid system snapshot in the available state.
If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.
If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text Source #

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

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-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.DocumentDB.CopyDBClusterSnapshot Methods (==) :: CopyDBClusterSnapshotResponse -> CopyDBClusterSnapshotResponse -> Bool # (/=) :: CopyDBClusterSnapshotResponse -> CopyDBClusterSnapshotResponse -> Bool #
Read CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot Methods readsPrec :: Int -> ReadS CopyDBClusterSnapshotResponse # readList :: ReadS [CopyDBClusterSnapshotResponse] # readPrec :: ReadPrec CopyDBClusterSnapshotResponse # readListPrec :: ReadPrec [CopyDBClusterSnapshotResponse] #
Show CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot Methods showsPrec :: Int -> CopyDBClusterSnapshotResponse -> ShowS # show :: CopyDBClusterSnapshotResponse -> String # showList :: [CopyDBClusterSnapshotResponse] -> ShowS #
Generic CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.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.DocumentDB.CopyDBClusterSnapshot Methods rnf :: CopyDBClusterSnapshotResponse -> () #
type Rep CopyDBClusterSnapshotResponse Source #
Instance details Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot type Rep CopyDBClusterSnapshotResponse = D1 ('MetaData "CopyDBClusterSnapshotResponse" "Amazonka.DocumentDB.CopyDBClusterSnapshot" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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.