public static interface CopyDBClusterSnapshotRequest.Builder extends RDSRequest.Builder, CopyableBuilder<CopyDBClusterSnapshotRequest.Builder,CopyDBClusterSnapshotRequest>
Modifier and Type | Method and Description |
---|---|
CopyDBClusterSnapshotRequest.Builder |
copyTags(Boolean copyTags)
True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise
false.
|
CopyDBClusterSnapshotRequest.Builder |
kmsKeyId(String kmsKeyId)
The AWS AWS KMS key ID for an encrypted DB cluster snapshot.
|
CopyDBClusterSnapshotRequest.Builder |
preSignedUrl(String preSignedUrl)
The URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot API
action in the AWS Region that contains the source DB cluster snapshot to copy. |
CopyDBClusterSnapshotRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
CopyDBClusterSnapshotRequest.Builder |
sourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier)
The identifier of the DB cluster snapshot to copy.
|
CopyDBClusterSnapshotRequest.Builder |
tags(Collection<Tag> tags)
Sets the value of the Tags property for this object.
|
CopyDBClusterSnapshotRequest.Builder |
tags(Tag... tags)
Sets the value of the Tags property for this object.
|
CopyDBClusterSnapshotRequest.Builder |
targetDBClusterSnapshotIdentifier(String targetDBClusterSnapshotIdentifier)
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
CopyDBClusterSnapshotRequest.Builder sourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier)
The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.
You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.
Constraints:
Must specify a valid system snapshot in the "available" state.
If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying a DB Snapshot or DB Cluster Snapshot.
Example: my-cluster-snapshot1
sourceDBClusterSnapshotIdentifier
- The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.
You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.
Constraints:
Must specify a valid system snapshot in the "available" state.
If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying a DB Snapshot or DB Cluster Snapshot.
Example: my-cluster-snapshot1
CopyDBClusterSnapshotRequest.Builder targetDBClusterSnapshotIdentifier(String 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
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
CopyDBClusterSnapshotRequest.Builder kmsKeyId(String kmsKeyId)
The AWS AWS 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 unencrypted DB cluster snapshot and specify a value for the KmsKeyId
parameter,
Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key.
If you copy an encrypted DB cluster snapshot from your AWS 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 AWS account, then you must specify a
value for KmsKeyId
.
To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId
to the KMS
key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS
encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys
from one AWS Region in another AWS Region.
kmsKeyId
- The AWS AWS 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 unencrypted DB cluster snapshot and specify a value for the KmsKeyId
parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key.
If you copy an encrypted DB cluster snapshot from your AWS 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 AWS account, then you must
specify a value for KmsKeyId
.
To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId
to
the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS
Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use
encryption keys from one AWS Region in another AWS Region.
CopyDBClusterSnapshotRequest.Builder preSignedUrl(String preSignedUrl)
The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot
API
action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl
parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region.
The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot
API action that can be
executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The
pre-signed URL request must contain the following parameter values:
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster
snapshot in the destination AWS Region. This is the same identifier for both the
CopyDBClusterSnapshot
action that is called in the destination AWS Region, and the action
contained in the pre-signed URL.
DestinationRegion
- The name of the AWS Region that the DB cluster snapshot will 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 AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS
Region, then your SourceDBClusterSnapshotIdentifier
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 (AWS Signature Version 4) and Signature Version 4 Signing Process.
preSignedUrl
- The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot
API action in the AWS Region that contains the source DB cluster snapshot to copy. The
PreSignedUrl
parameter must be used when copying an encrypted DB cluster snapshot from
another AWS Region.
The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot
API action that
can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB
cluster snapshot in the destination AWS Region. This is the same identifier for both the
CopyDBClusterSnapshot
action that is called in the destination AWS Region, and the action
contained in the pre-signed URL.
DestinationRegion
- The name of the AWS Region that the DB cluster snapshot will 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 AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the
us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier
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 (AWS Signature Version 4) and Signature Version 4 Signing Process.
CopyDBClusterSnapshotRequest.Builder copyTags(Boolean 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.
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.CopyDBClusterSnapshotRequest.Builder tags(Collection<Tag> tags)
tags
- The new value for the Tags property for this object.CopyDBClusterSnapshotRequest.Builder tags(Tag... tags)
tags
- The new value for the Tags property for this object.CopyDBClusterSnapshotRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.