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 |
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.
You can copy an encrypted DB cluster snapshot from another Amazon Web
Services Region. In that case, the Amazon Web Services Region where you
call the CopyDBClusterSnapshot
operation is the destination Amazon Web
Services Region for the encrypted DB cluster snapshot to be copied to.
To copy an encrypted DB cluster snapshot from another Amazon Web
Services Region, you must provide the following values:
KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as theSourceDBClusterSnapshotIdentifier
in the presigned URL.
To cancel the copy operation once it is in progress, delete the target
DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Synopsis
- data CopyDBClusterSnapshot = CopyDBClusterSnapshot' {}
- newCopyDBClusterSnapshot :: Text -> Text -> CopyDBClusterSnapshot
- copyDBClusterSnapshot_copyTags :: Lens' CopyDBClusterSnapshot (Maybe Bool)
- copyDBClusterSnapshot_destinationRegion :: Lens' CopyDBClusterSnapshot (Maybe Text)
- copyDBClusterSnapshot_kmsKeyId :: Lens' CopyDBClusterSnapshot (Maybe Text)
- copyDBClusterSnapshot_preSignedUrl :: Lens' CopyDBClusterSnapshot (Maybe Text)
- copyDBClusterSnapshot_tags :: Lens' CopyDBClusterSnapshot (Maybe [Tag])
- copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text
- copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text
- data CopyDBClusterSnapshotResponse = CopyDBClusterSnapshotResponse' {}
- newCopyDBClusterSnapshotResponse :: Int -> CopyDBClusterSnapshotResponse
- copyDBClusterSnapshotResponse_dbClusterSnapshot :: Lens' CopyDBClusterSnapshotResponse (Maybe DBClusterSnapshot)
- copyDBClusterSnapshotResponse_httpStatus :: Lens' CopyDBClusterSnapshotResponse Int
Creating a Request
data CopyDBClusterSnapshot Source #
See: newCopyDBClusterSnapshot
smart constructor.
CopyDBClusterSnapshot' | |
|
Instances
newCopyDBClusterSnapshot Source #
:: Text |
|
-> Text |
|
-> 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:copyTags:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_copyTags
- A value that indicates whether to copy all tags from the source DB
cluster snapshot to the target DB cluster snapshot. By default, tags are
not copied.
$sel:destinationRegion:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_destinationRegion
- Pseudo-parameter used when populating the PreSignedUrl
of a
cross-region CopyDBClusterSnapshot
request. To replicate from region
SRC
to region DST
, send a request to region DST
. In that request,
pass a PreSignedUrl
for region SRC
with DestinationRegion
set to
region DST
.
CopyDBClusterSnapshot
, copyDBClusterSnapshot_kmsKeyId
- The Amazon Web Services KMS key identifier for an encrypted DB cluster
snapshot. The Amazon Web Services KMS key identifier is the key ARN, key
ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web
Services account, you can specify a value for KmsKeyId
to encrypt the
copy with a new KMS 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 Web Services account, then you must specify a value for
KmsKeyId
.
To copy an encrypted DB cluster snapshot to another Amazon Web Services
Region, you must set KmsKeyId
to the Amazon Web Services KMS key
identifier you want to use to encrypt the copy of the DB cluster
snapshot in the destination Amazon Web Services Region. KMS keys are
specific to the Amazon Web Services Region that they are created in, and
you can't use KMS keys from one Amazon Web Services Region in another
Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for
the KmsKeyId
parameter, an error is returned.
$sel:preSignedUrl:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_preSignedUrl
- When you are copying a DB cluster snapshot from one Amazon Web Services
GovCloud (US) Region to another, the URL that contains a Signature
Version 4 signed request for the CopyDBClusterSnapshot
API operation
in the Amazon Web Services Region that contains the source DB cluster
snapshot to copy. Use the PreSignedUrl
parameter when copying an
encrypted DB cluster snapshot from another Amazon Web Services Region.
Don't specify PreSignedUrl
when copying an encrypted DB cluster
snapshot in the same Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
The presigned URL must be a valid request for the
CopyDBClusterSnapshot
API operation that can run in the source Amazon
Web Services Region that contains the encrypted DB cluster snapshot to
copy. The presigned URL request must contain the following parameter
values:
KmsKeyId
- The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both theCopyDBClusterSnapshot
operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.DestinationRegion
- The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then yourSourceDBClusterSnapshotIdentifier
looks like the following example:arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
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 presigned URL that is a valid request for the operation
that can run in the source Amazon Web Services Region.
$sel:tags:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_tags
- Undocumented member.
$sel:sourceDBClusterSnapshotIdentifier:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier
- The identifier of the DB cluster snapshot to copy. This parameter isn't
case-sensitive.
You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
Constraints:
- Must specify a valid system snapshot in the "available" state.
- If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
- If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
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 isn't case-sensitive.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
Request Lenses
copyDBClusterSnapshot_copyTags :: Lens' CopyDBClusterSnapshot (Maybe Bool) Source #
A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
copyDBClusterSnapshot_destinationRegion :: Lens' CopyDBClusterSnapshot (Maybe Text) Source #
Pseudo-parameter used when populating the PreSignedUrl
of a
cross-region CopyDBClusterSnapshot
request. To replicate from region
SRC
to region DST
, send a request to region DST
. In that request,
pass a PreSignedUrl
for region SRC
with DestinationRegion
set to
region DST
.
copyDBClusterSnapshot_kmsKeyId :: Lens' CopyDBClusterSnapshot (Maybe Text) Source #
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web
Services account, you can specify a value for KmsKeyId
to encrypt the
copy with a new KMS 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 Web Services account, then you must specify a value for
KmsKeyId
.
To copy an encrypted DB cluster snapshot to another Amazon Web Services
Region, you must set KmsKeyId
to the Amazon Web Services KMS key
identifier you want to use to encrypt the copy of the DB cluster
snapshot in the destination Amazon Web Services Region. KMS keys are
specific to the Amazon Web Services Region that they are created in, and
you can't use KMS keys from one Amazon Web Services Region in another
Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for
the KmsKeyId
parameter, an error is returned.
copyDBClusterSnapshot_preSignedUrl :: Lens' CopyDBClusterSnapshot (Maybe Text) Source #
When you are copying a DB cluster snapshot from one Amazon Web Services
GovCloud (US) Region to another, the URL that contains a Signature
Version 4 signed request for the CopyDBClusterSnapshot
API operation
in the Amazon Web Services Region that contains the source DB cluster
snapshot to copy. Use the PreSignedUrl
parameter when copying an
encrypted DB cluster snapshot from another Amazon Web Services Region.
Don't specify PreSignedUrl
when copying an encrypted DB cluster
snapshot in the same Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
The presigned URL must be a valid request for the
CopyDBClusterSnapshot
API operation that can run in the source Amazon
Web Services Region that contains the encrypted DB cluster snapshot to
copy. The presigned URL request must contain the following parameter
values:
KmsKeyId
- The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both theCopyDBClusterSnapshot
operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.DestinationRegion
- The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then yourSourceDBClusterSnapshotIdentifier
looks like the following example:arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
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 presigned URL that is a valid request for the operation
that can run in the source Amazon Web Services Region.
copyDBClusterSnapshot_tags :: Lens' CopyDBClusterSnapshot (Maybe [Tag]) Source #
Undocumented member.
copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text Source #
The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.
You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
Constraints:
- Must specify a valid system snapshot in the "available" state.
- If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
- If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
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 isn't case-sensitive.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
Destructuring the Response
data CopyDBClusterSnapshotResponse Source #
See: newCopyDBClusterSnapshotResponse
smart constructor.
CopyDBClusterSnapshotResponse' | |
|
Instances
newCopyDBClusterSnapshotResponse Source #
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.