public static interface PutObjectRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
Modifier and Type | Method and Description |
---|---|
PutObjectRequest.Builder |
acl(ObjectCannedACL acl)
The canned ACL to apply to the object.
|
PutObjectRequest.Builder |
acl(String acl)
The canned ACL to apply to the object.
|
PutObjectRequest.Builder |
bucket(String bucket)
The bucket name to which the PUT action was initiated.
|
PutObjectRequest.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).
|
PutObjectRequest.Builder |
cacheControl(String cacheControl)
Can be used to specify caching behavior along the request/reply chain.
|
PutObjectRequest.Builder |
checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
PutObjectRequest.Builder |
checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
PutObjectRequest.Builder |
checksumCRC32(String checksumCRC32)
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent.
|
PutObjectRequest.Builder |
checksumCRC32C(String checksumCRC32C)
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent.
|
PutObjectRequest.Builder |
checksumSHA1(String checksumSHA1)
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent.
|
PutObjectRequest.Builder |
checksumSHA256(String checksumSHA256)
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent.
|
PutObjectRequest.Builder |
contentDisposition(String contentDisposition)
Specifies presentational information for the object.
|
PutObjectRequest.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.
|
PutObjectRequest.Builder |
contentLanguage(String contentLanguage)
The language the content is in.
|
PutObjectRequest.Builder |
contentLength(Long contentLength)
Size of the body in bytes.
|
PutObjectRequest.Builder |
contentMD5(String contentMD5)
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864.
|
PutObjectRequest.Builder |
contentType(String contentType)
A standard MIME type describing the format of the contents.
|
PutObjectRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
PutObjectRequest.Builder |
expires(Instant expires)
The date and time at which the object is no longer cacheable.
|
PutObjectRequest.Builder |
grantFullControl(String grantFullControl)
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
|
PutObjectRequest.Builder |
grantRead(String grantRead)
Allows grantee to read the object data and its metadata.
|
PutObjectRequest.Builder |
grantReadACP(String grantReadACP)
Allows grantee to read the object ACL.
|
PutObjectRequest.Builder |
grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable object.
|
PutObjectRequest.Builder |
key(String key)
Object key for which the PUT action was initiated.
|
PutObjectRequest.Builder |
metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
|
PutObjectRequest.Builder |
objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether a legal hold will be applied to this object.
|
PutObjectRequest.Builder |
objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether a legal hold will be applied to this object.
|
PutObjectRequest.Builder |
objectLockMode(ObjectLockMode objectLockMode)
The Object Lock mode that you want to apply to this object.
|
PutObjectRequest.Builder |
objectLockMode(String objectLockMode)
The Object Lock mode that you want to apply to this object.
|
PutObjectRequest.Builder |
objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when you want this object's Object Lock to expire.
|
PutObjectRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutObjectRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutObjectRequest.Builder |
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
PutObjectRequest.Builder |
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
PutObjectRequest.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 ). |
PutObjectRequest.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 ). |
PutObjectRequest.Builder |
sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (for example, AES256).
|
PutObjectRequest.Builder |
sseCustomerKey(String sseCustomerKey)
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
PutObjectRequest.Builder |
sseCustomerKeyMD5(String sseCustomerKeyMD5)
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
PutObjectRequest.Builder |
ssekmsEncryptionContext(String ssekmsEncryptionContext)
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption.
|
PutObjectRequest.Builder |
ssekmsKeyId(String ssekmsKeyId)
If
x-amz-server-side-encryption has a valid value of aws:kms or
aws:kms:dsse , this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key Management
Service (KMS) symmetric encryption customer managed key that was used for the object. |
PutObjectRequest.Builder |
storageClass(StorageClass storageClass)
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
|
PutObjectRequest.Builder |
storageClass(String storageClass)
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
|
PutObjectRequest.Builder |
tagging(String tagging)
The tag-set for the object.
|
PutObjectRequest.Builder |
tagging(Tagging tagging) |
PutObjectRequest.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.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
PutObjectRequest.Builder acl(String acl)
The canned ACL to apply to the object. For more information, see Canned ACL.
This action is not supported by Amazon S3 on Outposts.
acl
- The canned ACL to apply to the object. For more information, see Canned ACL.
This action is not supported by Amazon S3 on Outposts.
ObjectCannedACL
,
ObjectCannedACL
PutObjectRequest.Builder acl(ObjectCannedACL acl)
The canned ACL to apply to the object. For more information, see Canned ACL.
This action is not supported by Amazon S3 on Outposts.
acl
- The canned ACL to apply to the object. For more information, see Canned ACL.
This action is not supported by Amazon S3 on Outposts.
ObjectCannedACL
,
ObjectCannedACL
PutObjectRequest.Builder bucket(String bucket)
The bucket name to which the PUT action was initiated.
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.
bucket
- The bucket name to which the PUT action was initiated.
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.
PutObjectRequest.Builder cacheControl(String cacheControl)
Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
cacheControl
- Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616
/rfc2616-sec14.html#sec14.9.PutObjectRequest.Builder contentDisposition(String contentDisposition)
Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
contentDisposition
- Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.PutObjectRequest.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. For more information, see https://www.rfc-editor.org/rfc/rfc9110 .html#field.content-encoding.
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. For more
information, see https://www
.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.PutObjectRequest.Builder contentLanguage(String contentLanguage)
The language the content is in.
contentLanguage
- The language the content is in.PutObjectRequest.Builder contentLength(Long contentLength)
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.
contentLength
- Size of the body in bytes. This parameter is useful when the size of the body cannot be determined
automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.PutObjectRequest.Builder contentMD5(String contentMD5)
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
contentMD5
- The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This
header can be used as a message integrity check to verify that the data is the same data that was
originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an
end-to-end integrity check. For more information about REST request authentication, see REST
Authentication.PutObjectRequest.Builder contentType(String contentType)
A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
contentType
- A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.PutObjectRequest.Builder checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
provide any additional functionality if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3
fails the request with the HTTP status code 400 Bad Request
. For more information, see Checking object
integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
checksumAlgorithm
- Indicates the algorithm used to create the checksum for the object when using the SDK. This header
will not provide any additional functionality if not using the SDK. When sending this header, there
must be a corresponding x-amz-checksum
or x-amz-trailer
header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
. For
more information, see Checking
object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
ChecksumAlgorithm
,
ChecksumAlgorithm
PutObjectRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
provide any additional functionality if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3
fails the request with the HTTP status code 400 Bad Request
. For more information, see Checking object
integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
checksumAlgorithm
- Indicates the algorithm used to create the checksum for the object when using the SDK. This header
will not provide any additional functionality if not using the SDK. When sending this header, there
must be a corresponding x-amz-checksum
or x-amz-trailer
header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
. For
more information, see Checking
object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
ChecksumAlgorithm
,
ChecksumAlgorithm
PutObjectRequest.Builder checksumCRC32(String checksumCRC32)
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumCRC32
- This header can be used as a data integrity check to verify that the data received is the same data
that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the
object. For more information, see Checking
object integrity in the Amazon S3 User Guide.PutObjectRequest.Builder checksumCRC32C(String checksumCRC32C)
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumCRC32C
- This header can be used as a data integrity check to verify that the data received is the same data
that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the
object. For more information, see Checking
object integrity in the Amazon S3 User Guide.PutObjectRequest.Builder checksumSHA1(String checksumSHA1)
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumSHA1
- This header can be used as a data integrity check to verify that the data received is the same data
that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the
object. For more information, see Checking
object integrity in the Amazon S3 User Guide.PutObjectRequest.Builder checksumSHA256(String checksumSHA256)
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumSHA256
- This header can be used as a data integrity check to verify that the data received is the same data
that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the
object. For more information, see Checking
object integrity in the Amazon S3 User Guide.PutObjectRequest.Builder expires(Instant expires)
The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.
expires
- The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.PutObjectRequest.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.
grantFullControl
- Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
PutObjectRequest.Builder grantRead(String grantRead)
Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
grantRead
- Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
PutObjectRequest.Builder grantReadACP(String grantReadACP)
Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
grantReadACP
- Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
PutObjectRequest.Builder grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
grantWriteACP
- Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
PutObjectRequest.Builder key(String key)
Object key for which the PUT action was initiated.
key
- Object key for which the PUT action was initiated.PutObjectRequest.Builder metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
metadata
- A map of metadata to store with the object in S3.PutObjectRequest.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
).
serverSideEncryption
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
, aws:kms
, aws:kms:dsse
).ServerSideEncryption
,
ServerSideEncryption
PutObjectRequest.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
).
serverSideEncryption
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
, aws:kms
, aws:kms:dsse
).ServerSideEncryption
,
ServerSideEncryption
PutObjectRequest.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.
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.StorageClass
,
StorageClass
PutObjectRequest.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.
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.StorageClass
,
StorageClass
PutObjectRequest.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. For information about object metadata, see Object Key and Metadata.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
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.
For information about object metadata, see Object Key and
Metadata.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
PutObjectRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (for example, AES256).
sseCustomerAlgorithm
- Specifies the algorithm to use to when encrypting the object (for example, AES256).PutObjectRequest.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.
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.PutObjectRequest.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.
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.PutObjectRequest.Builder ssekmsKeyId(String ssekmsKeyId)
If x-amz-server-side-encryption
has a valid value of aws:kms
or
aws:kms:dsse
, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key Management
Service (KMS) symmetric encryption customer managed key that was used for the object. If you specify
x-amz-server-side-encryption:aws:kms
or x-amz-server-side-encryption:aws:kms:dsse
,
but do not provide x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the Amazon Web
Services managed key (aws/s3
) to protect the data. If the KMS key does not exist in the same
account that's issuing the command, you must use the full ARN and not just the ID.
ssekmsKeyId
- If x-amz-server-side-encryption
has a valid value of aws:kms
or
aws:kms:dsse
, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key
Management Service (KMS) symmetric encryption customer managed key that was used for the object. If
you specify x-amz-server-side-encryption:aws:kms
or
x-amz-server-side-encryption:aws:kms:dsse
, but do not provide
x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the Amazon Web Services
managed key (aws/s3
) to protect the data. If the KMS key does not exist in the same
account that's issuing the command, you must use the full ARN and not just the ID.PutObjectRequest.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. This value
is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future
GetObject
or CopyObject
operations on this object.
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.
This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS
for future GetObject
or CopyObject
operations on this object.PutObjectRequest.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 PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
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 PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
PutObjectRequest.Builder requestPayer(String requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectRequest.Builder tagging(String tagging)
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
tagging
- The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example,
"Key1=Value1")PutObjectRequest.Builder tagging(Tagging tagging)
PutObjectRequest.Builder objectLockMode(String objectLockMode)
The Object Lock mode that you want to apply to this object.
objectLockMode
- The Object Lock mode that you want to apply to this object.ObjectLockMode
,
ObjectLockMode
PutObjectRequest.Builder objectLockMode(ObjectLockMode objectLockMode)
The Object Lock mode that you want to apply to this object.
objectLockMode
- The Object Lock mode that you want to apply to this object.ObjectLockMode
,
ObjectLockMode
PutObjectRequest.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
objectLockRetainUntilDate
- The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp
parameter.PutObjectRequest.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
objectLockLegalHoldStatus
- Specifies whether a legal hold will be applied to this object. For more information about S3 Object
Lock, see Object Lock.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
PutObjectRequest.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
objectLockLegalHoldStatus
- Specifies whether a legal hold will be applied to this object. For more information about S3 Object
Lock, see Object Lock.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
PutObjectRequest.Builder expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden
(access denied).
expectedBucketOwner
- The account ID of the expected bucket owner. If the bucket is owned by a different account, the
request fails with the HTTP status code 403 Forbidden
(access denied).PutObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
PutObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.