Interface CopyDbClusterSnapshotRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CopyDbClusterSnapshotRequest.Builder,
,CopyDbClusterSnapshotRequest> RdsRequest.Builder
,SdkBuilder<CopyDbClusterSnapshotRequest.Builder,
,CopyDbClusterSnapshotRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CopyDbClusterSnapshotRequest
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot.The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.preSignedUrl
(String 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 theCopyDBClusterSnapshot
API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy.sourceDBClusterSnapshotIdentifier
(String sourceDBClusterSnapshotIdentifier) The identifier of the DB cluster snapshot to copy.sourceRegion
(String sourceRegion) If PreSignedUrl is not specified, this is the region where the source snapshot is located.tags
(Collection<Tag> tags) Sets the value of the Tags property for this object.tags
(Consumer<Tag.Builder>... tags) Sets the value of the Tags property for this object.Sets the value of the Tags property for this object.targetDBClusterSnapshotIdentifier
(String targetDBClusterSnapshotIdentifier) The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
sourceDBClusterSnapshotIdentifier
CopyDbClusterSnapshotRequest.Builder sourceDBClusterSnapshotIdentifier(String 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
- Parameters:
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
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
targetDBClusterSnapshotIdentifier
CopyDbClusterSnapshotRequest.Builder targetDBClusterSnapshotIdentifier(String 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
- Parameters:
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
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 forKmsKeyId
, 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.- Parameters:
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 forKmsKeyId
, 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 thePreSignedUrl
parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specifyPreSignedUrl
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 specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.- Parameters:
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 theCopyDBClusterSnapshot
API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use thePreSignedUrl
parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specifyPreSignedUrl
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 specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
copyTags
Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
- Parameters:
copyTags
- Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object.- Parameters:
tags
- The new value for the Tags property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object.- Parameters:
tags
- The new value for the Tags property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object. This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceRegion
If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.- Parameters:
sourceRegion
- If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CopyDbClusterSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CopyDbClusterSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-