Package software.amazon.awssdk.services.elasticache.model

Interface CopySnapshotRequest.Builder

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

  • Method Details

    • sourceSnapshotName

      CopySnapshotRequest.Builder sourceSnapshotName(String sourceSnapshotName)

      The name of an existing snapshot from which to make a copy.

      Parameters:
      sourceSnapshotName - The name of an existing snapshot from which to make a copy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetSnapshotName

      CopySnapshotRequest.Builder targetSnapshotName(String targetSnapshotName)

      A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

      Parameters:
      targetSnapshotName - A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetBucket

      CopySnapshotRequest.Builder targetBucket(String targetBucket)

      The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

      When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

      For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

      Parameters:
      targetBucket - The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

      When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

      For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

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

    • kmsKeyId

      CopySnapshotRequest.Builder kmsKeyId(String kmsKeyId)

      The ID of the KMS key used to encrypt the target snapshot.

      Parameters:
      kmsKeyId - The ID of the KMS key used to encrypt the target snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CopySnapshotRequest.Builder tags(Collection<Tag> tags)

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      Parameters:
      tags - A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CopySnapshotRequest.Builder tags(Tag... tags)

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      Parameters:
      tags - A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      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:

    • overrideConfiguration

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

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