Class PutObjectRequest
- 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.PutObjectRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutObjectRequest extends S3Request implements ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PutObjectRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete 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()
The bucket name to which the PUT action was initiated.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 PutObjectRequest.Builder
builder()
String
cacheControl()
Can be used to specify caching behavior along the request/reply chain.ChecksumAlgorithm
checksumAlgorithm()
Indicates the algorithm used to create the checksum for the object when you use the SDK.String
checksumAlgorithmAsString()
Indicates the algorithm used to create the checksum for the object when you use the SDK.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.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.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.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.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.Long
contentLength()
Size of the body in bytes.String
contentMD5()
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864.String
contentType()
A standard MIME type describing the format of the contents.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
expectedBucketOwner()
The account ID of the expected 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()
Object key for which the PUT action was initiated.Map<String,String>
metadata()
A map of metadata to store with the object in S3.ObjectLockLegalHoldStatus
objectLockLegalHoldStatus()
Specifies whether a legal hold will be applied to this object.String
objectLockLegalHoldStatusAsString()
Specifies whether a legal hold will be applied to this object.ObjectLockMode
objectLockMode()
The Object Lock mode that you want to apply to this object.String
objectLockModeAsString()
The Object Lock mode that you want to apply to this object.Instant
objectLockRetainUntilDate()
The date and time when you want this 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 PutObjectRequest.Builder>
serializableBuilderClass()
ServerSideEncryption
serverSideEncryption()
The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).String
serverSideEncryptionAsString()
The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).String
sseCustomerAlgorithm()
Specifies the algorithm to use 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()
Ifx-amz-server-side-encryption
has a valid value ofaws:kms
oraws: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.StorageClass
storageClass()
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.String
storageClassAsString()
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.String
tagging()
The tag-set for the object.PutObjectRequest.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. For more information, see Canned ACL in the Amazon S3 User Guide.
When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.
If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the
bucket-owner-full-control
canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a400
error with the error codeAccessControlListNotSupported
. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.-
This functionality is not supported for directory buckets.
-
This functionality is not supported for 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. For more information, see Canned ACL in the
Amazon S3 User Guide.
When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.
If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the
bucket-owner-full-control
canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a400
error with the error codeAccessControlListNotSupported
. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
- See Also:
ObjectCannedACL
-
-
aclAsString
public final String aclAsString()
The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide.
When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.
If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the
bucket-owner-full-control
canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a400
error with the error codeAccessControlListNotSupported
. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.-
This functionality is not supported for directory buckets.
-
This functionality is not supported for 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. For more information, see Canned ACL in the
Amazon S3 User Guide.
When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.
If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the
bucket-owner-full-control
canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a400
error with the error codeAccessControlListNotSupported
. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
- See Also:
ObjectCannedACL
-
-
bucket
public final String bucket()
The bucket name to which the PUT action was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-BUCKET--usw2-az2--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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 bucket name to which the PUT action was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-BUCKET--usw2-az2--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.
-
cacheControl
public final 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.
- Returns:
- 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.
-
contentDisposition
public final String contentDisposition()
Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
- Returns:
- Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
-
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. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.
- 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. For more information, see https://www.rfc-editor.org /rfc/rfc9110.html#field.content-encoding.
-
contentLanguage
public final String contentLanguage()
The language the content is in.
- Returns:
- The language the content is in.
-
contentLength
public final 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.
- Returns:
- 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.
-
contentMD5
public final 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.
The
Content-MD5
header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.This functionality is not supported for directory buckets.
- Returns:
- 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.
The
Content-MD5
header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.This functionality is not supported for directory buckets.
-
contentType
public final 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.
- Returns:
- 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.
-
checksumAlgorithm
public final ChecksumAlgorithm checksumAlgorithm()
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum-algorithm
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
.For the
x-amz-checksum-algorithm
header, replacealgorithm
with the supported algorithm from the following list:-
CRC32
-
CRC32C
-
SHA1
-
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through
x-amz-checksum-algorithm
doesn't match the checksum algorithm you set throughx-amz-sdk-checksum-algorithm
, Amazon S3 ignores any providedChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value inx-amz-checksum-algorithm
.For directory buckets, when you use Amazon Web Services SDKs,
CRC32
is the default checksum algorithm that's used for performance.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 used to create the checksum for the object when you use the SDK. This header will
not provide any additional functionality if you don't use the SDK. When you send this header, there must
be a corresponding
x-amz-checksum-algorithm
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
.For the
x-amz-checksum-algorithm
header, replacealgorithm
with the supported algorithm from the following list:-
CRC32
-
CRC32C
-
SHA1
-
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through
x-amz-checksum-algorithm
doesn't match the checksum algorithm you set throughx-amz-sdk-checksum-algorithm
, Amazon S3 ignores any providedChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value inx-amz-checksum-algorithm
.For directory buckets, when you use Amazon Web Services SDKs,
CRC32
is the default checksum algorithm that's used for performance. -
- See Also:
ChecksumAlgorithm
-
-
checksumAlgorithmAsString
public final String checksumAlgorithmAsString()
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum-algorithm
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
.For the
x-amz-checksum-algorithm
header, replacealgorithm
with the supported algorithm from the following list:-
CRC32
-
CRC32C
-
SHA1
-
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through
x-amz-checksum-algorithm
doesn't match the checksum algorithm you set throughx-amz-sdk-checksum-algorithm
, Amazon S3 ignores any providedChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value inx-amz-checksum-algorithm
.For directory buckets, when you use Amazon Web Services SDKs,
CRC32
is the default checksum algorithm that's used for performance.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 used to create the checksum for the object when you use the SDK. This header will
not provide any additional functionality if you don't use the SDK. When you send this header, there must
be a corresponding
x-amz-checksum-algorithm
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
.For the
x-amz-checksum-algorithm
header, replacealgorithm
with the supported algorithm from the following list:-
CRC32
-
CRC32C
-
SHA1
-
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through
x-amz-checksum-algorithm
doesn't match the checksum algorithm you set throughx-amz-sdk-checksum-algorithm
, Amazon S3 ignores any providedChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value inx-amz-checksum-algorithm
.For directory buckets, when you use Amazon Web Services SDKs,
CRC32
is the default checksum algorithm that's used for performance. -
- See Also:
ChecksumAlgorithm
-
-
checksumCRC32
public final 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.
- Returns:
- 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.
-
checksumCRC32C
public final 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.
- Returns:
- 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.
-
checksumSHA1
public final 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.
- Returns:
- 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.
-
checksumSHA256
public final 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.
- Returns:
- 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.
-
expires
public final 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.
- Returns:
- 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.
-
grantFullControl
public final String grantFullControl()
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
-
-
grantRead
public final String grantRead()
Allows grantee to read the object data and its metadata.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Allows grantee to read the object data and its metadata.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
-
-
grantReadACP
public final String grantReadACP()
Allows grantee to read the object ACL.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Allows grantee to read the object ACL.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
-
-
grantWriteACP
public final String grantWriteACP()
Allows grantee to write the ACL for the applicable object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Allows grantee to write the ACL for the applicable object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
-
-
key
public final String key()
Object key for which the PUT action was initiated.
- Returns:
- Object key for which the PUT action was initiated.
-
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.
-
serverSideEncryption
public final ServerSideEncryption serverSideEncryption()
The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) value is supported.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 that was used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) value is supported. - See Also:
ServerSideEncryption
-
serverSideEncryptionAsString
public final String serverSideEncryptionAsString()
The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) value is supported.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 that was used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) value is supported. - See Also:
ServerSideEncryption
-
storageClass
public final 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. For more information, see Storage Classes in the Amazon S3 User Guide.
-
For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
-
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
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:
- 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. For more information, see Storage Classes in
the Amazon S3 User Guide.
-
For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
-
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
-
- See Also:
StorageClass
-
-
storageClassAsString
public final String storageClassAsString()
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. For more information, see Storage Classes in the Amazon S3 User Guide.
-
For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
-
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
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:
- 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. For more information, see Storage Classes in
the Amazon S3 User Guide.
-
For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
-
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
-
- 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. For information about object metadata, see Object Key and Metadata in the Amazon S3 User Guide.
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 in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
- 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. For
information about object metadata, see Object Key and Metadata in
the Amazon S3 User Guide.
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 in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
-
sseCustomerAlgorithm
public final String sseCustomerAlgorithm()
Specifies the algorithm to use when encrypting the object (for example,
AES256
).This functionality is not supported for directory buckets.
- Returns:
- Specifies the algorithm to use when encrypting the object (for example,
AES256
).This functionality is not supported for directory buckets.
-
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.This functionality is not supported for directory buckets.
- 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.This functionality is not supported for directory buckets.
-
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.
This functionality is not supported for directory buckets.
- 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.
This functionality is not supported for directory buckets.
-
ssekmsKeyId
public final String ssekmsKeyId()
If
x-amz-server-side-encryption
has a valid value ofaws:kms
oraws: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 specifyx-amz-server-side-encryption:aws:kms
orx-amz-server-side-encryption:aws:kms:dsse
, but do not providex-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.This functionality is not supported for directory buckets.
- Returns:
- If
x-amz-server-side-encryption
has a valid value ofaws:kms
oraws: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 specifyx-amz-server-side-encryption:aws:kms
orx-amz-server-side-encryption:aws:kms:dsse
, but do not providex-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.This functionality is not supported for directory buckets.
-
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. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future
GetObject
orCopyObject
operations on this object. This value must be explicitly added duringCopyObject
operations.This functionality is not supported for directory buckets.
- 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. This
value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future
GetObject
orCopyObject
operations on this object. This value must be explicitly added duringCopyObject
operations.This functionality is not supported for directory buckets.
-
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 PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
This functionality is not supported for directory buckets.
- 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 PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
This functionality is not supported for directory buckets.
-
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. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
This functionality is not supported for directory buckets.
- Returns:
- The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example,
"Key1=Value1")
This functionality is not supported for directory buckets.
-
objectLockMode
public final ObjectLockMode objectLockMode()
The Object Lock mode that you want to apply to this object.
This functionality is not supported for directory buckets.
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 this object.
This functionality is not supported for directory buckets.
- See Also:
ObjectLockMode
-
objectLockModeAsString
public final String objectLockModeAsString()
The Object Lock mode that you want to apply to this object.
This functionality is not supported for directory buckets.
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 this object.
This functionality is not supported for directory buckets.
- See Also:
ObjectLockMode
-
objectLockRetainUntilDate
public final Instant objectLockRetainUntilDate()
The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
This functionality is not supported for directory buckets.
- Returns:
- The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp
parameter.
This functionality is not supported for directory buckets.
-
objectLockLegalHoldStatus
public final ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
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 a legal hold will be applied to this object. For more information about S3 Object Lock,
see Object Lock in the
Amazon S3 User Guide.
This functionality is not supported for directory buckets.
- See Also:
ObjectLockLegalHoldStatus
-
objectLockLegalHoldStatusAsString
public final String objectLockLegalHoldStatusAsString()
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
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 a legal hold will be applied to this object. For more information about S3 Object Lock,
see Object Lock in the
Amazon S3 User Guide.
This functionality is not supported for directory buckets.
- See Also:
ObjectLockLegalHoldStatus
-
expectedBucketOwner
public final String expectedBucketOwner()
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied).- Returns:
- The account ID of the expected bucket owner. If the account ID that you provide does not match the actual
owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied).
-
toBuilder
public PutObjectRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
- Specified by:
toBuilder
in classS3Request
-
builder
public static PutObjectRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutObjectRequest.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
-
-