Package software.amazon.awssdk.services.neptune.model

Interface CopyDbClusterSnapshotRequest.Builder

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

  • Method Details

    • sourceDBClusterSnapshotIdentifier

      CopyDbClusterSnapshotRequest.Builder sourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier)

      The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

      Constraints:

      • Must specify a valid system snapshot in the "available" state.

      • Specify a valid DB snapshot identifier.

      Example: my-cluster-snapshot1

      Parameters:
      sourceDBClusterSnapshotIdentifier - The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

      Constraints:

      • Must specify a valid system snapshot in the "available" state.

      • Specify a valid DB snapshot identifier.

      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 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

      Parameters:
      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

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

    • kmsKeyId

      CopyDbClusterSnapshotRequest.Builder kmsKeyId(String kmsKeyId)

      The Amazon Amazon 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 encrypted DB cluster snapshot from your Amazon 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 Amazon account, then you must specify a value for KmsKeyId.

      KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

      You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

      Parameters:
      kmsKeyId - The Amazon Amazon 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 encrypted DB cluster snapshot from your Amazon 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 Amazon account, then you must specify a value for KmsKeyId.

      KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

      You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to 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

      CopyDbClusterSnapshotRequest.Builder preSignedUrl(String preSignedUrl)

      Not currently supported.

      Parameters:
      preSignedUrl - Not currently supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copyTags

      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.

      Parameters:
      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.
      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 assign to the new DB cluster snapshot copy.

      Parameters:
      tags - The tags to assign to the new DB cluster snapshot copy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CopyDbClusterSnapshotRequest.Builder tags(Tag... tags)

      The tags to assign to the new DB cluster snapshot copy.

      Parameters:
      tags - The tags to assign to the new DB cluster snapshot copy.
      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 assign to the new DB cluster snapshot copy.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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)
      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

      CopyDbClusterSnapshotRequest.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.