CopyObjectRequest.Builder (AWS Java SDK :: Services

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 Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`CopyObjectRequest.Builder`	`acl(ObjectCannedACL acl)` The canned ACL to apply to the object.
`CopyObjectRequest.Builder`	`acl(String acl)` The canned ACL to apply to the object.
`CopyObjectRequest.Builder`	`bucket(String destinationBucket)` Deprecated. Use `destinationBucket(String)`
`CopyObjectRequest.Builder`	`bucketKeyEnabled(Boolean bucketKeyEnabled)` Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS).
`CopyObjectRequest.Builder`	`cacheControl(String cacheControl)` Specifies caching behavior along the request/reply chain.
`CopyObjectRequest.Builder`	`contentDisposition(String contentDisposition)` Specifies presentational information for the object.
`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.
`CopyObjectRequest.Builder`	`contentLanguage(String contentLanguage)` The language the content is in.
`CopyObjectRequest.Builder`	`contentType(String contentType)` A standard MIME type describing the format of the object data.
`CopyObjectRequest.Builder`	`copySource(String copySource)` Specifies the source object for the copy operation.
`CopyObjectRequest.Builder`	`copySourceIfMatch(String copySourceIfMatch)` Copies the object if its entity tag (ETag) matches the specified tag.
`CopyObjectRequest.Builder`	`copySourceIfModifiedSince(Instant copySourceIfModifiedSince)` Copies the object if it has been modified since the specified time.
`CopyObjectRequest.Builder`	`copySourceIfNoneMatch(String copySourceIfNoneMatch)` Copies the object if its entity tag (ETag) is different than the specified ETag.
`CopyObjectRequest.Builder`	`copySourceIfUnmodifiedSince(Instant copySourceIfUnmodifiedSince)` Copies the object if it hasn't been modified since the specified time.
`CopyObjectRequest.Builder`	`copySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm)` Specifies the algorithm to use when decrypting the source object (for example, AES256).
`CopyObjectRequest.Builder`	`copySourceSSECustomerKey(String copySourceSSECustomerKey)` Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.
`CopyObjectRequest.Builder`	`copySourceSSECustomerKeyMD5(String copySourceSSECustomerKeyMD5)` Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
`CopyObjectRequest.Builder`	`destinationBucket(String destinationBucket)` The name of the destination bucket.
`CopyObjectRequest.Builder`	`destinationKey(String destinationKey)` The key of the destination object.
`CopyObjectRequest.Builder`	`expectedBucketOwner(String expectedBucketOwner)` The account ID of the expected destination bucket owner.
`CopyObjectRequest.Builder`	`expectedSourceBucketOwner(String expectedSourceBucketOwner)` The account ID of the expected source bucket owner.
`CopyObjectRequest.Builder`	`expires(Instant expires)` The date and time at which the object is no longer cacheable.
`CopyObjectRequest.Builder`	`grantFullControl(String grantFullControl)` Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
`CopyObjectRequest.Builder`	`grantRead(String grantRead)` Allows grantee to read the object data and its metadata.
`CopyObjectRequest.Builder`	`grantReadACP(String grantReadACP)` Allows grantee to read the object ACL.
`CopyObjectRequest.Builder`	`grantWriteACP(String grantWriteACP)` Allows grantee to write the ACL for the applicable object.
`CopyObjectRequest.Builder`	`key(String destinationKey)` Deprecated. Use `destinationKey(String)`
`CopyObjectRequest.Builder`	`metadata(Map<String,String> metadata)` A map of metadata to store with the object in S3.
`CopyObjectRequest.Builder`	`metadataDirective(MetadataDirective metadataDirective)` Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
`CopyObjectRequest.Builder`	`metadataDirective(String metadataDirective)` Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
`CopyObjectRequest.Builder`	`objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)` Specifies whether you want to apply a Legal Hold to the copied object.
`CopyObjectRequest.Builder`	`objectLockLegalHoldStatus(String objectLockLegalHoldStatus)` Specifies whether you want to apply a Legal Hold to the copied object.
`CopyObjectRequest.Builder`	`objectLockMode(ObjectLockMode objectLockMode)` The Object Lock mode that you want to apply to the copied object.
`CopyObjectRequest.Builder`	`objectLockMode(String objectLockMode)` The Object Lock mode that you want to apply to the copied object.
`CopyObjectRequest.Builder`	`objectLockRetainUntilDate(Instant objectLockRetainUntilDate)` The date and time when you want the copied object's Object Lock to expire.
`CopyObjectRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`CopyObjectRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`CopyObjectRequest.Builder`	`requestPayer(RequestPayer requestPayer)` Sets the value of the RequestPayer property for this object.
`CopyObjectRequest.Builder`	`requestPayer(String requestPayer)` Sets the value of the RequestPayer property for this object.
`CopyObjectRequest.Builder`	`serverSideEncryption(ServerSideEncryption serverSideEncryption)` The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
`CopyObjectRequest.Builder`	`serverSideEncryption(String serverSideEncryption)` The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
`CopyObjectRequest.Builder`	`sseCustomerAlgorithm(String sseCustomerAlgorithm)` Specifies the algorithm to use to when encrypting the object (for example, AES256).
`CopyObjectRequest.Builder`	`sseCustomerKey(String sseCustomerKey)` Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
`CopyObjectRequest.Builder`	`sseCustomerKeyMD5(String sseCustomerKeyMD5)` Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
`CopyObjectRequest.Builder`	`ssekmsEncryptionContext(String ssekmsEncryptionContext)` Specifies the AWS KMS Encryption Context to use for object encryption.
`CopyObjectRequest.Builder`	`ssekmsKeyId(String ssekmsKeyId)` Specifies the AWS KMS key ID to use for object encryption.
`CopyObjectRequest.Builder`	`storageClass(StorageClass storageClass)` By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
`CopyObjectRequest.Builder`	`storageClass(String storageClass)` By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
`CopyObjectRequest.Builder`	`tagging(String tagging)` The tag-set for the object destination object this value must be used in conjunction with the `TaggingDirective`.
`CopyObjectRequest.Builder`	`tagging(Tagging tagging)`
`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.
`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.
`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.

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.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
  - 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:
    
    ObjectCannedACL, ObjectCannedACL
  - 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:
    
    ObjectCannedACL, ObjectCannedACL
  - 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.
  - 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
```
CopyObjectRequest.Builder copySource(String 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 AWS 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 AWS 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, MetadataDirective
  - 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:
    
    MetadataDirective, MetadataDirective
  - 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, TaggingDirective
  - 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:
    
    TaggingDirective, TaggingDirective
  - serverSideEncryption
```
CopyObjectRequest.Builder serverSideEncryption(String serverSideEncryption)
```
    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
    
    Parameters:
    
    serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ServerSideEncryption, ServerSideEncryption
  - serverSideEncryption
```
CopyObjectRequest.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
```
    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
    
    Parameters:
    
    serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ServerSideEncryption, ServerSideEncryption
  - storageClass
```
CopyObjectRequest.Builder storageClass(String storageClass)
```
    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. 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 - By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. 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, StorageClass
  - storageClass
```
CopyObjectRequest.Builder storageClass(StorageClass storageClass)
```
    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. 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 - By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. 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, StorageClass
  - 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.
    
    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.
    
    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 AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
    
    Parameters:
    
    ssekmsKeyId - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS 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 AWS 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 AWS 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 AWS KMS (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 AWS KMS (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, RequestPayer
  - 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:
    
    RequestPayer, RequestPayer
  - 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, ObjectLockMode
  - 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:
    
    ObjectLockMode, ObjectLockMode
  - 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, ObjectLockLegalHoldStatus
  - 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:
    
    ObjectLockLegalHoldStatus, ObjectLockLegalHoldStatus
  - 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 will fail with an HTTP 403 (Access Denied) error.
    
    Parameters:
    
    expectedBucketOwner - The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
    
    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 will fail with an HTTP 403 (Access Denied) error.
    
    Parameters:
    
    expectedSourceBucketOwner - The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
    
    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 AWS 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 using 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 using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using 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 AWS 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 using 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 using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using 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 AWS 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 using 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 using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using 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 AWS 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 using 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 using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using 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.
  - overrideConfiguration
```
CopyObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
CopyObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface CopyObjectRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder

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

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

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

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

Method Detail

acl

acl

cacheControl

contentDisposition

contentEncoding

contentLanguage

contentType

copySource

copySourceIfMatch

copySourceIfModifiedSince

copySourceIfNoneMatch

copySourceIfUnmodifiedSince

expires

grantFullControl

grantRead

grantReadACP

grantWriteACP

metadata

metadataDirective

metadataDirective

taggingDirective

taggingDirective

serverSideEncryption

serverSideEncryption

storageClass

storageClass

websiteRedirectLocation

sseCustomerAlgorithm

sseCustomerKey

sseCustomerKeyMD5

ssekmsKeyId

ssekmsEncryptionContext

bucketKeyEnabled

copySourceSSECustomerAlgorithm

copySourceSSECustomerKey

copySourceSSECustomerKeyMD5

requestPayer

requestPayer

tagging

tagging

objectLockMode

objectLockMode

objectLockRetainUntilDate

objectLockLegalHoldStatus

objectLockLegalHoldStatus

expectedBucketOwner

expectedSourceBucketOwner

destinationBucket

bucket

destinationKey

key

overrideConfiguration

overrideConfiguration