Interface CopyDbClusterSnapshotRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CopyDbClusterSnapshotRequest.Builder,
,CopyDbClusterSnapshotRequest> DocDbRequest.Builder
,SdkBuilder<CopyDbClusterSnapshotRequest.Builder,
,CopyDbClusterSnapshotRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CopyDbClusterSnapshotRequest
-
Method Summary
Modifier and TypeMethodDescriptionSet totrue
to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwisefalse
.The KMS key ID for an encrypted 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) The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot
API action in the Amazon Web Services Region that contains the source cluster snapshot to copy.sourceDBClusterSnapshotIdentifier
(String sourceDBClusterSnapshotIdentifier) The identifier of the 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) The tags to be assigned to the cluster snapshot.tags
(Consumer<Tag.Builder>... tags) The tags to be assigned to the cluster snapshot.The tags to be assigned to the cluster snapshot.targetDBClusterSnapshotIdentifier
(String targetDBClusterSnapshotIdentifier) The identifier of the new cluster snapshot to create from the source 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.docdb.model.DocDbRequest.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 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 Amazon Web Services Region as the copy, specify a valid snapshot identifier.
-
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.
Example:
my-cluster-snapshot1
- Parameters:
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 Amazon Web Services Region as the copy, specify a valid snapshot identifier.
-
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.
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 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
- Parameters:
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
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 Amazon Web Services 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 forKmsKeyId
, 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 Amazon Web Services account, then you must specify a value for
KmsKeyId
.To copy an encrypted cluster snapshot to another Amazon Web Services 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 Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.If you copy an unencrypted cluster snapshot and specify a value for the
KmsKeyId
parameter, an error is returned.- Parameters:
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 Amazon Web Services 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 forKmsKeyId
, 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 Amazon Web Services account, then you must specify a value for
KmsKeyId
.To copy an encrypted cluster snapshot to another Amazon Web Services 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 Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.If you copy an unencrypted 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
The URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use thePreSignedUrl
parameter when copying a cluster snapshot from another Amazon Web Services 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 specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.The presigned URL must be a valid request for the
CopyDBClusterSnapshot
API action that can be executed in the source Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then yourSourceDBClusterSnapshotIdentifier
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.
- Parameters:
preSignedUrl
- The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot
API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use thePreSignedUrl
parameter when copying a cluster snapshot from another Amazon Web Services 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 specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.The presigned URL must be a valid request for the
CopyDBClusterSnapshot
API action that can be executed in the source Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then yourSourceDBClusterSnapshotIdentifier
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
copyTags
Set to
true
to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwisefalse
. The default isfalse
.- Parameters:
copyTags
- Set totrue
to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwisefalse
. The default isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to be assigned to the cluster snapshot.
- Parameters:
tags
- The tags to be assigned to the cluster snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to be assigned to the cluster snapshot.
- Parameters:
tags
- The tags to be assigned to the cluster snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to be assigned to the cluster snapshot.
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.
-