Class CopyObjectRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.s3.model.S3Request
-
- software.amazon.awssdk.services.s3.model.CopyObjectRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>
@Generated("software.amazon.awssdk:codegen") public final class CopyObjectRequest extends S3Request implements ToCopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CopyObjectRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ObjectCannedACL
acl()
The canned ACL to apply to the object.String
aclAsString()
The canned ACL to apply to the object.String
bucket()
Deprecated.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).static CopyObjectRequest.Builder
builder()
String
cacheControl()
Specifies caching behavior along the request/reply chain.ChecksumAlgorithm
checksumAlgorithm()
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object.String
checksumAlgorithmAsString()
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object.String
contentDisposition()
Specifies presentational information for the object.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.String
contentLanguage()
The language the content is in.String
contentType()
A standard MIME type describing the format of the object data.String
copySource()
Deprecated.ThecopySource
parameter has been deprecated in favor of the more user-friendlysourceBucket
,sourceKey
, andsourceVersionId
parameters.String
copySourceIfMatch()
Copies the object if its entity tag (ETag) matches the specified tag.Instant
copySourceIfModifiedSince()
Copies the object if it has been modified since the specified time.String
copySourceIfNoneMatch()
Copies the object if its entity tag (ETag) is different than the specified ETag.Instant
copySourceIfUnmodifiedSince()
Copies the object if it hasn't been modified since the specified time.String
copySourceSSECustomerAlgorithm()
Specifies the algorithm to use when decrypting the source object (for example, AES256).String
copySourceSSECustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.String
copySourceSSECustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.String
destinationBucket()
The name of the destination bucket.String
destinationKey()
The key of the destination object.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
expectedBucketOwner()
The account ID of the expected destination bucket owner.String
expectedSourceBucketOwner()
The account ID of the expected source bucket owner.Instant
expires()
The date and time at which the object is no longer cacheable.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
String
grantFullControl()
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.String
grantRead()
Allows grantee to read the object data and its metadata.String
grantReadACP()
Allows grantee to read the object ACL.String
grantWriteACP()
Allows grantee to write the ACL for the applicable object.int
hashCode()
boolean
hasMetadata()
For responses, this returns true if the service returned a value for the Metadata property.String
key()
Deprecated.UsedestinationKey()
Map<String,String>
metadata()
A map of metadata to store with the object in S3.MetadataDirective
metadataDirective()
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.String
metadataDirectiveAsString()
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.ObjectLockLegalHoldStatus
objectLockLegalHoldStatus()
Specifies whether you want to apply a legal hold to the copied object.String
objectLockLegalHoldStatusAsString()
Specifies whether you want to apply a legal hold to the copied object.ObjectLockMode
objectLockMode()
The Object Lock mode that you want to apply to the copied object.String
objectLockModeAsString()
The Object Lock mode that you want to apply to the copied object.Instant
objectLockRetainUntilDate()
The date and time when you want the copied object's Object Lock to expire.RequestPayer
requestPayer()
Returns the value of the RequestPayer property for this object.String
requestPayerAsString()
Returns the value of the RequestPayer property for this object.List<SdkField<?>>
sdkFields()
static Class<? extends CopyObjectRequest.Builder>
serializableBuilderClass()
ServerSideEncryption
serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).String
serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).String
sourceBucket()
The name of the bucket containing the object to copy.String
sourceKey()
The key of the object to copy.String
sourceVersionId()
Specifies a particular version of the source object to copy.String
sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).String
sseCustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.String
sseCustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.String
ssekmsEncryptionContext()
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption.String
ssekmsKeyId()
Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption.StorageClass
storageClass()
If thex-amz-storage-class
header is not used, the copied object will be stored in the STANDARD Storage Class by default.String
storageClassAsString()
If thex-amz-storage-class
header is not used, the copied object will be stored in the STANDARD Storage Class by default.String
tagging()
The tag-set for the object destination object this value must be used in conjunction with theTaggingDirective
.TaggingDirective
taggingDirective()
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.String
taggingDirectiveAsString()
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.CopyObjectRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
acl
public final ObjectCannedACL acl()
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
If the service returns an enum value that is not available in the current SDK version,
acl
will returnObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaclAsString()
.- Returns:
- The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
- See Also:
ObjectCannedACL
-
aclAsString
public final String aclAsString()
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
If the service returns an enum value that is not available in the current SDK version,
acl
will returnObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaclAsString()
.- Returns:
- The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
- See Also:
ObjectCannedACL
-
cacheControl
public final String cacheControl()
Specifies caching behavior along the request/reply chain.
- Returns:
- Specifies caching behavior along the request/reply chain.
-
checksumAlgorithm
public final 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.
If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithm
will returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- 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.
- See Also:
ChecksumAlgorithm
-
checksumAlgorithmAsString
public final String checksumAlgorithmAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithm
will returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- 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.
- See Also:
ChecksumAlgorithm
-
contentDisposition
public final String contentDisposition()
Specifies presentational information for the object.
- Returns:
- Specifies presentational information for the object.
-
contentEncoding
public final 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.
- Returns:
- 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.
-
contentLanguage
public final String contentLanguage()
The language the content is in.
- Returns:
- The language the content is in.
-
contentType
public final String contentType()
A standard MIME type describing the format of the object data.
- Returns:
- A standard MIME type describing the format of the object data.
-
copySource
@Deprecated public final String copySource()
Deprecated.ThecopySource
parameter has been deprecated in favor of the more user-friendlysourceBucket
,sourceKey
, andsourceVersionId
parameters. ThecopySource
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 bucketawsexamplebucket
, useawsexamplebucket/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 objectreports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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 objectreports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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:
- 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 bucketawsexamplebucket
, useawsexamplebucket/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 objectreports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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 objectreports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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. -
-
-
copySourceIfMatch
public final String copySourceIfMatch()
Copies the object if its entity tag (ETag) matches the specified tag.
- Returns:
- Copies the object if its entity tag (ETag) matches the specified tag.
-
copySourceIfModifiedSince
public final Instant copySourceIfModifiedSince()
Copies the object if it has been modified since the specified time.
- Returns:
- Copies the object if it has been modified since the specified time.
-
copySourceIfNoneMatch
public final String copySourceIfNoneMatch()
Copies the object if its entity tag (ETag) is different than the specified ETag.
- Returns:
- Copies the object if its entity tag (ETag) is different than the specified ETag.
-
copySourceIfUnmodifiedSince
public final Instant copySourceIfUnmodifiedSince()
Copies the object if it hasn't been modified since the specified time.
- Returns:
- Copies the object if it hasn't been modified since the specified time.
-
expires
public final Instant expires()
The date and time at which the object is no longer cacheable.
- Returns:
- The date and time at which the object is no longer cacheable.
-
grantFullControl
public final 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.
- Returns:
- Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
-
grantRead
public final String grantRead()
Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
- Returns:
- Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
-
grantReadACP
public final String grantReadACP()
Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
- Returns:
- Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
-
grantWriteACP
public final String grantWriteACP()
Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
- Returns:
- Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
-
hasMetadata
public final boolean hasMetadata()
For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
metadata
public final Map<String,String> metadata()
A map of metadata to store with the object in S3.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetadata()
method.- Returns:
- A map of metadata to store with the object in S3.
-
metadataDirective
public final MetadataDirective metadataDirective()
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
If the service returns an enum value that is not available in the current SDK version,
metadataDirective
will returnMetadataDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetadataDirectiveAsString()
.- Returns:
- Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
- See Also:
MetadataDirective
-
metadataDirectiveAsString
public final String metadataDirectiveAsString()
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
If the service returns an enum value that is not available in the current SDK version,
metadataDirective
will returnMetadataDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetadataDirectiveAsString()
.- Returns:
- Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
- See Also:
MetadataDirective
-
taggingDirective
public final TaggingDirective taggingDirective()
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
If the service returns an enum value that is not available in the current SDK version,
taggingDirective
will returnTaggingDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaggingDirectiveAsString()
.- Returns:
- Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
- See Also:
TaggingDirective
-
taggingDirectiveAsString
public final String taggingDirectiveAsString()
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
If the service returns an enum value that is not available in the current SDK version,
taggingDirective
will returnTaggingDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaggingDirectiveAsString()
.- Returns:
- Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
- See Also:
TaggingDirective
-
serverSideEncryption
public final ServerSideEncryption serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will returnServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserverSideEncryptionAsString()
.- Returns:
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
). - See Also:
ServerSideEncryption
-
serverSideEncryptionAsString
public final String serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will returnServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserverSideEncryptionAsString()
.- Returns:
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
). - See Also:
ServerSideEncryption
-
storageClass
public final 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.If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- 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. - See Also:
StorageClass
-
storageClassAsString
public final String storageClassAsString()
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.If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- 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. - See Also:
StorageClass
-
websiteRedirectLocation
public final 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.- Returns:
- 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.
-
sseCustomerAlgorithm
public final String sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
- Returns:
- Specifies the algorithm to use to when encrypting the object (for example, AES256).
-
sseCustomerKey
public final 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.- Returns:
- 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.
-
sseCustomerKeyMD5
public final 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.
- Returns:
- 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.
-
ssekmsKeyId
public final 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.
- Returns:
- 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.
-
ssekmsEncryptionContext
public final 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.
- Returns:
- 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.
-
bucketKeyEnabled
public final 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.
- Returns:
- 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.
-
copySourceSSECustomerAlgorithm
public final String copySourceSSECustomerAlgorithm()
Specifies the algorithm to use when decrypting the source object (for example, AES256).
- Returns:
- Specifies the algorithm to use when decrypting the source object (for example, AES256).
-
copySourceSSECustomerKey
public final 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.
- Returns:
- 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.
-
copySourceSSECustomerKeyMD5
public final 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.
- Returns:
- 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.
-
requestPayer
public final RequestPayer requestPayer()
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
RequestPayer
-
requestPayerAsString
public final String requestPayerAsString()
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
RequestPayer
-
tagging
public final 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.- Returns:
- 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.
-
objectLockMode
public final ObjectLockMode objectLockMode()
The Object Lock mode that you want to apply to the copied object.
If the service returns an enum value that is not available in the current SDK version,
objectLockMode
will returnObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectLockModeAsString()
.- Returns:
- The Object Lock mode that you want to apply to the copied object.
- See Also:
ObjectLockMode
-
objectLockModeAsString
public final String objectLockModeAsString()
The Object Lock mode that you want to apply to the copied object.
If the service returns an enum value that is not available in the current SDK version,
objectLockMode
will returnObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectLockModeAsString()
.- Returns:
- The Object Lock mode that you want to apply to the copied object.
- See Also:
ObjectLockMode
-
objectLockRetainUntilDate
public final Instant objectLockRetainUntilDate()
The date and time when you want the copied object's Object Lock to expire.
- Returns:
- The date and time when you want the copied object's Object Lock to expire.
-
objectLockLegalHoldStatus
public final ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
Specifies whether you want to apply a legal hold to the copied object.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will returnObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectLockLegalHoldStatusAsString()
.- Returns:
- Specifies whether you want to apply a legal hold to the copied object.
- See Also:
ObjectLockLegalHoldStatus
-
objectLockLegalHoldStatusAsString
public final String objectLockLegalHoldStatusAsString()
Specifies whether you want to apply a legal hold to the copied object.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will returnObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectLockLegalHoldStatusAsString()
.- Returns:
- Specifies whether you want to apply a legal hold to the copied object.
- See Also:
ObjectLockLegalHoldStatus
-
expectedBucketOwner
public final 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).- Returns:
- 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).
-
expectedSourceBucketOwner
public final 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).- Returns:
- 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).
-
bucket
@Deprecated public final String bucket()
Deprecated.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:
- 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.
-
destinationBucket
public final 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.- Returns:
- 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.
-
key
@Deprecated public final String key()
Deprecated.UsedestinationKey()
The key of the destination object.
- Returns:
- The key of the destination object.
-
destinationKey
public final String destinationKey()
The key of the destination object.
- Returns:
- The key of the destination object.
-
sourceBucket
public final String sourceBucket()
The name of the bucket containing the object to copy. The provided input will be URL encoded. ThesourceBucket
,sourceKey
, andsourceVersionId
parameters must not be used in conjunction with thecopySource
parameter.- Returns:
- The name of the bucket containing the object to copy. The provided input will be URL encoded. The
sourceBucket
,sourceKey
, andsourceVersionId
parameters must not be used in conjunction with thecopySource
parameter.
-
sourceKey
public final String sourceKey()
The key of the object to copy. The provided input will be URL encoded. ThesourceBucket
,sourceKey
, andsourceVersionId
parameters must not be used in conjunction with thecopySource
parameter.- Returns:
- The key of the object to copy. The provided input will be URL encoded. The
sourceBucket
,sourceKey
, andsourceVersionId
parameters must not be used in conjunction with thecopySource
parameter.
-
sourceVersionId
public final String sourceVersionId()
Specifies a particular version of the source object to copy. By default the latest version is copied. ThesourceBucket
,sourceKey
, andsourceVersionId
parameters must not be used in conjunction with thecopySource
parameter.- Returns:
- Specifies a particular version of the source object to copy. By default the latest version is copied. The
sourceBucket
,sourceKey
, andsourceVersionId
parameters must not be used in conjunction with thecopySource
parameter.
-
toBuilder
public CopyObjectRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>
- Specified by:
toBuilder
in classS3Request
-
builder
public static CopyObjectRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CopyObjectRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-