software.amazon.awssdk.services.docdb.model

Interface CopyDbClusterSnapshotRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CopyDbClusterSnapshotRequest.Builder,CopyDbClusterSnapshotRequest>, DocDbRequest.Builder, SdkBuilder<CopyDbClusterSnapshotRequest.Builder,CopyDbClusterSnapshotRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CopyDbClusterSnapshotRequest

public static interface CopyDbClusterSnapshotRequest.Builder
extends DocDbRequest.Builder, SdkPojo, CopyableBuilder<CopyDbClusterSnapshotRequest.Builder,CopyDbClusterSnapshotRequest>

Method Summary

Modifier and Type	Method and Description
CopyDbClusterSnapshotRequest.Builder	copyTags(Boolean copyTags) Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false.
CopyDbClusterSnapshotRequest.Builder	kmsKeyId(String kmsKeyId) The AWS KMS key ID for an encrypted cluster snapshot.
CopyDbClusterSnapshotRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CopyDbClusterSnapshotRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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 cluster snapshot to copy.
CopyDbClusterSnapshotRequest.Builder	sourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier) The identifier of the cluster snapshot to copy.
CopyDbClusterSnapshotRequest.Builder	sourceRegion(String sourceRegion) If PreSignedUrl is not specified, this is the region where the source snapshot is located.
CopyDbClusterSnapshotRequest.Builder	tags(Collection<Tag> tags) The tags to be assigned to the cluster snapshot.
CopyDbClusterSnapshotRequest.Builder	tags(Consumer<Tag.Builder>... tags) The tags to be assigned to the cluster snapshot.
CopyDbClusterSnapshotRequest.Builder	tags(Tag... tags) The tags to be assigned to the cluster snapshot.
CopyDbClusterSnapshotRequest.Builder	targetDBClusterSnapshotIdentifier(String targetDBClusterSnapshotIdentifier) The identifier of the new cluster snapshot to create from the source cluster snapshot.

Methods inherited from interface software.amazon.awssdk.services.docdb.model.DocDbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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 AWS Region as the copy, specify a valid snapshot identifier.

• If the source snapshot is in a different AWS 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 AWS Region as the copy, specify a valid snapshot identifier.

• If the source snapshot is in a different AWS 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

CopyDbClusterSnapshotRequest.Builder kmsKeyId(String kmsKeyId)

The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.

If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot.

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

To copy an encrypted cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS 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.

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

Parameters:

kmsKeyId - The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.

If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot.

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

To copy an encrypted cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS 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.

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

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 cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another AWS Region.

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS 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 AWS Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS 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 AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 AWS 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.

Parameters:

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

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS 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 AWS Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS 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 AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 AWS 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

copyTags

CopyDbClusterSnapshotRequest.Builder copyTags(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CopyDbClusterSnapshotRequest.Builder tags(Collection<Tag> 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

CopyDbClusterSnapshotRequest.Builder tags(Tag... 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

CopyDbClusterSnapshotRequest.Builder tags(Consumer<Tag.Builder>... tags)

The tags to be assigned to the cluster snapshot.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

sourceRegion

CopyDbClusterSnapshotRequest.Builder sourceRegion(String 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CopyDbClusterSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder