Package software.amazon.awssdk.services.docdbelastic.model

Interface CopyClusterSnapshotRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CopyClusterSnapshotRequest.Builder,CopyClusterSnapshotRequest>, DocDbElasticRequest.Builder, SdkBuilder<CopyClusterSnapshotRequest.Builder,CopyClusterSnapshotRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CopyClusterSnapshotRequest
public static interface CopyClusterSnapshotRequest.Builder extends DocDbElasticRequest.Builder, SdkPojo, CopyableBuilder<CopyClusterSnapshotRequest.Builder,CopyClusterSnapshotRequest>

  • Method Details

    • copyTags

      CopyClusterSnapshotRequest.Builder copyTags(Boolean copyTags)

      Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

      Parameters:
      copyTags - Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CopyClusterSnapshotRequest.Builder kmsKeyId(String kmsKeyId)

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

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

      To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services 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 elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

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

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

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

    • snapshotArn

      CopyClusterSnapshotRequest.Builder snapshotArn(String snapshotArn)

      The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

      Parameters:
      snapshotArn - The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CopyClusterSnapshotRequest.Builder tags(Map<String,String> tags)

      The tags to be assigned to the elastic cluster snapshot.

      Parameters:
      tags - The tags to be assigned to the elastic cluster snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetSnapshotName

      CopyClusterSnapshotRequest.Builder targetSnapshotName(String targetSnapshotName)

      The identifier of the new elastic 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: elastic-cluster-snapshot-5

      Parameters:
      targetSnapshotName - The identifier of the new elastic 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: elastic-cluster-snapshot-5

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

    • overrideConfiguration

      CopyClusterSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CopyClusterSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.