Package software.amazon.awssdk.services.s3.model

Interface CopyObjectRequest.Builder

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

  • Method Details

    • acl

      CopyObjectRequest.Builder acl(String acl)

      The canned ACL to apply to the object.

      This action is not supported by Amazon S3 on Outposts.

      Parameters:
      acl - The canned ACL to apply to the object.

      This action is not supported by Amazon S3 on Outposts.

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

    • acl

      CopyObjectRequest.Builder acl(ObjectCannedACL acl)

      The canned ACL to apply to the object.

      This action is not supported by Amazon S3 on Outposts.

      Parameters:
      acl - The canned ACL to apply to the object.

      This action is not supported by Amazon S3 on Outposts.

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

    • cacheControl

      CopyObjectRequest.Builder cacheControl(String cacheControl)

      Specifies caching behavior along the request/reply chain.

      Parameters:
      cacheControl - Specifies caching behavior along the request/reply chain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumAlgorithm

      CopyObjectRequest.Builder checksumAlgorithm(String checksumAlgorithm)

      Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumAlgorithm - Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • checksumAlgorithm

      CopyObjectRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

      Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumAlgorithm - Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentDisposition

      CopyObjectRequest.Builder contentDisposition(String contentDisposition)

      Specifies presentational information for the object.

      Parameters:
      contentDisposition - Specifies presentational information for the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentEncoding

      CopyObjectRequest.Builder contentEncoding(String contentEncoding)

      Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

      Parameters:
      contentEncoding - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentLanguage

      CopyObjectRequest.Builder contentLanguage(String contentLanguage)

      The language the content is in.

      Parameters:
      contentLanguage - The language the content is in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentType

      CopyObjectRequest.Builder contentType(String contentType)

      A standard MIME type describing the format of the object data.

      Parameters:
      contentType - A standard MIME type describing the format of the object data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copySource

      @Deprecated CopyObjectRequest.Builder copySource(String copySource)
      Deprecated.
      The copySource parameter has been deprecated in favor of the more user-friendly sourceBucket, sourceKey, and sourceVersionId parameters. The copySource parameter will remain fully functional, but it must not be used in conjunction with its replacement parameters.

      Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

      • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.

      • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key> . For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

        Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

        Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key> . For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

      To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

      Parameters:
      copySource - Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

      • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.

      • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key> . For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

        Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

        Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key> . For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

      To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

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

    • copySourceIfMatch

      CopyObjectRequest.Builder copySourceIfMatch(String copySourceIfMatch)

      Copies the object if its entity tag (ETag) matches the specified tag.

      Parameters:
      copySourceIfMatch - Copies the object if its entity tag (ETag) matches the specified tag.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copySourceIfModifiedSince

      CopyObjectRequest.Builder copySourceIfModifiedSince(Instant copySourceIfModifiedSince)

      Copies the object if it has been modified since the specified time.

      Parameters:
      copySourceIfModifiedSince - Copies the object if it has been modified since the specified time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copySourceIfNoneMatch

      CopyObjectRequest.Builder copySourceIfNoneMatch(String copySourceIfNoneMatch)

      Copies the object if its entity tag (ETag) is different than the specified ETag.

      Parameters:
      copySourceIfNoneMatch - Copies the object if its entity tag (ETag) is different than the specified ETag.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copySourceIfUnmodifiedSince

      CopyObjectRequest.Builder copySourceIfUnmodifiedSince(Instant copySourceIfUnmodifiedSince)

      Copies the object if it hasn't been modified since the specified time.

      Parameters:
      copySourceIfUnmodifiedSince - Copies the object if it hasn't been modified since the specified time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expires

      CopyObjectRequest.Builder expires(Instant expires)

      The date and time at which the object is no longer cacheable.

      Parameters:
      expires - The date and time at which the object is no longer cacheable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • grantFullControl

      CopyObjectRequest.Builder grantFullControl(String grantFullControl)

      Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

      This action is not supported by Amazon S3 on Outposts.

      Parameters:
      grantFullControl - Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

      This action is not supported by Amazon S3 on Outposts.

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

    • grantRead

      CopyObjectRequest.Builder grantRead(String grantRead)

      Allows grantee to read the object data and its metadata.

      This action is not supported by Amazon S3 on Outposts.

      Parameters:
      grantRead - Allows grantee to read the object data and its metadata.

      This action is not supported by Amazon S3 on Outposts.

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

    • grantReadACP

      CopyObjectRequest.Builder grantReadACP(String grantReadACP)

      Allows grantee to read the object ACL.

      This action is not supported by Amazon S3 on Outposts.

      Parameters:
      grantReadACP - Allows grantee to read the object ACL.

      This action is not supported by Amazon S3 on Outposts.

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

    • grantWriteACP

      CopyObjectRequest.Builder grantWriteACP(String grantWriteACP)

      Allows grantee to write the ACL for the applicable object.

      This action is not supported by Amazon S3 on Outposts.

      Parameters:
      grantWriteACP - Allows grantee to write the ACL for the applicable object.

      This action is not supported by Amazon S3 on Outposts.

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

    • metadata

      CopyObjectRequest.Builder metadata(Map<String,String> metadata)

      A map of metadata to store with the object in S3.

      Parameters:
      metadata - A map of metadata to store with the object in S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataDirective

      CopyObjectRequest.Builder metadataDirective(String metadataDirective)

      Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

      Parameters:
      metadataDirective - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadataDirective

      CopyObjectRequest.Builder metadataDirective(MetadataDirective metadataDirective)

      Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

      Parameters:
      metadataDirective - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taggingDirective

      CopyObjectRequest.Builder taggingDirective(String taggingDirective)

      Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

      Parameters:
      taggingDirective - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taggingDirective

      CopyObjectRequest.Builder taggingDirective(TaggingDirective taggingDirective)

      Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

      Parameters:
      taggingDirective - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serverSideEncryption

      CopyObjectRequest.Builder serverSideEncryption(String serverSideEncryption)

      The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

      Parameters:
      serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serverSideEncryption

      CopyObjectRequest.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)

      The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

      Parameters:
      serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageClass

      CopyObjectRequest.Builder storageClass(String storageClass)

      If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

      Parameters:
      storageClass - If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageClass

      CopyObjectRequest.Builder storageClass(StorageClass storageClass)

      If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

      Parameters:
      storageClass - If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • websiteRedirectLocation

      CopyObjectRequest.Builder websiteRedirectLocation(String websiteRedirectLocation)

      If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the directive.

      Parameters:
      websiteRedirectLocation - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the directive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sseCustomerAlgorithm

      CopyObjectRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

      Parameters:
      sseCustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for example, AES256).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sseCustomerKey

      CopyObjectRequest.Builder sseCustomerKey(String sseCustomerKey)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

      Parameters:
      sseCustomerKey - Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sseCustomerKeyMD5

      CopyObjectRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

      Parameters:
      sseCustomerKeyMD5 - Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ssekmsKeyId

      CopyObjectRequest.Builder ssekmsKeyId(String ssekmsKeyId)

      Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

      Parameters:
      ssekmsKeyId - Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ssekmsEncryptionContext

      CopyObjectRequest.Builder ssekmsEncryptionContext(String ssekmsEncryptionContext)

      Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

      Parameters:
      ssekmsEncryptionContext - Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucketKeyEnabled

      CopyObjectRequest.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)

      Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

      Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

      Parameters:
      bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

      Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

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

    • copySourceSSECustomerAlgorithm

      CopyObjectRequest.Builder copySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm)

      Specifies the algorithm to use when decrypting the source object (for example, AES256).

      Parameters:
      copySourceSSECustomerAlgorithm - Specifies the algorithm to use when decrypting the source object (for example, AES256).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copySourceSSECustomerKey

      CopyObjectRequest.Builder copySourceSSECustomerKey(String copySourceSSECustomerKey)

      Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

      Parameters:
      copySourceSSECustomerKey - Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copySourceSSECustomerKeyMD5

      CopyObjectRequest.Builder copySourceSSECustomerKeyMD5(String copySourceSSECustomerKeyMD5)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

      Parameters:
      copySourceSSECustomerKeyMD5 - Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestPayer

      CopyObjectRequest.Builder requestPayer(String requestPayer)
      Sets the value of the RequestPayer property for this object.
      Parameters:
      requestPayer - The new value for the RequestPayer property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestPayer

      CopyObjectRequest.Builder requestPayer(RequestPayer requestPayer)
      Sets the value of the RequestPayer property for this object.
      Parameters:
      requestPayer - The new value for the RequestPayer property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tagging

      CopyObjectRequest.Builder tagging(String tagging)

      The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

      Parameters:
      tagging - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagging

      CopyObjectRequest.Builder tagging(Tagging tagging)

    • objectLockMode

      CopyObjectRequest.Builder objectLockMode(String objectLockMode)

      The Object Lock mode that you want to apply to the copied object.

      Parameters:
      objectLockMode - The Object Lock mode that you want to apply to the copied object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockMode

      CopyObjectRequest.Builder objectLockMode(ObjectLockMode objectLockMode)

      The Object Lock mode that you want to apply to the copied object.

      Parameters:
      objectLockMode - The Object Lock mode that you want to apply to the copied object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockRetainUntilDate

      CopyObjectRequest.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)

      The date and time when you want the copied object's Object Lock to expire.

      Parameters:
      objectLockRetainUntilDate - The date and time when you want the copied object's Object Lock to expire.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • objectLockLegalHoldStatus

      CopyObjectRequest.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)

      Specifies whether you want to apply a legal hold to the copied object.

      Parameters:
      objectLockLegalHoldStatus - Specifies whether you want to apply a legal hold to the copied object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockLegalHoldStatus

      CopyObjectRequest.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)

      Specifies whether you want to apply a legal hold to the copied object.

      Parameters:
      objectLockLegalHoldStatus - Specifies whether you want to apply a legal hold to the copied object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expectedBucketOwner

      CopyObjectRequest.Builder expectedBucketOwner(String expectedBucketOwner)

      The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

      Parameters:
      expectedBucketOwner - The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expectedSourceBucketOwner

      CopyObjectRequest.Builder expectedSourceBucketOwner(String expectedSourceBucketOwner)

      The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

      Parameters:
      expectedSourceBucketOwner - The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationBucket

      CopyObjectRequest.Builder destinationBucket(String destinationBucket)

      The name of the destination bucket.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

      Parameters:
      destinationBucket - The name of the destination bucket.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

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

    • bucket

      @Deprecated CopyObjectRequest.Builder bucket(String destinationBucket)
      Deprecated.
      Use destinationBucket(String)

      The name of the destination bucket.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

      Parameters:
      destinationBucket - The name of the destination bucket.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

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

    • destinationKey

      CopyObjectRequest.Builder destinationKey(String destinationKey)

      The key of the destination object.

      Parameters:
      destinationKey - The key of the destination object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • key

      @Deprecated CopyObjectRequest.Builder key(String destinationKey)
      Deprecated.
      Use destinationKey(String)

      The key of the destination object.

      Parameters:
      destinationKey - The key of the destination object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceBucket

      CopyObjectRequest.Builder sourceBucket(String sourceBucket)
      The name of the bucket containing the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
      Parameters:
      sourceBucket - The name of the bucket containing the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceKey

      CopyObjectRequest.Builder sourceKey(String sourceKey)
      The key of the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
      Parameters:
      sourceKey - The key of the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceVersionId

      CopyObjectRequest.Builder sourceVersionId(String sourceVersionId)
      Specifies a particular version of the source object to copy. By default the latest version is copied. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
      Parameters:
      sourceVersionId - Specifies a particular version of the source object to copy. By default the latest version is copied. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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