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

Interface PutObjectRequest.Builder

    • Method Detail

      • acl

        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.

        Parameters:
        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.

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

      • acl

        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.

        Parameters:
        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.

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

      • bucket

        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.

        Parameters:
        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.

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

      • contentLanguage

        PutObjectRequest.Builder contentLanguage​(String contentLanguage)

        The language the content is in.

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

      • contentMD5

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • checksumAlgorithm

        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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ChecksumAlgorithm, 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.

        Parameters:
        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.

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

      • checksumCRC32

        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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • checksumCRC32C

        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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • checksumSHA1

        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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • checksumSHA256

        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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • grantFullControl

        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.

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

        This action is not supported by Amazon S3 on Outposts.

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

      • grantRead

        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.

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

        This action is not supported by Amazon S3 on Outposts.

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

      • grantReadACP

        PutObjectRequest.Builder grantReadACP​(String grantReadACP)

        Allows grantee to read the object ACL.

        This action is not supported by Amazon S3 on Outposts.

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

        This action is not supported by Amazon S3 on Outposts.

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

      • grantWriteACP

        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.

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

        This action is not supported by Amazon S3 on Outposts.

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

      • key

        PutObjectRequest.Builder key​(String key)

        Object key for which the PUT action was initiated.

        Parameters:
        key - Object key for which the PUT action was initiated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metadata

        PutObjectRequest.Builder metadata​(Map<String,​String> metadata)

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

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

      • serverSideEncryption

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

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

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

      • storageClass

        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.

        Parameters:
        storageClass - By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StorageClass, StorageClass

      • storageClass

        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.

        Parameters:
        storageClass - By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StorageClass, StorageClass

      • websiteRedirectLocation

        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.

        Parameters:
        websiteRedirectLocation - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. 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.

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

      • sseCustomerAlgorithm

        PutObjectRequest.Builder sseCustomerAlgorithm​(String sseCustomerAlgorithm)

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

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

      • sseCustomerKey

        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.

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

      • sseCustomerKeyMD5

        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.

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

      • ssekmsKeyId

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ssekmsEncryptionContext

        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. This value must be explicitly added during CopyObject operations.

        Parameters:
        ssekmsEncryptionContext - Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. 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. This value must be explicitly added during CopyObject operations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • bucketKeyEnabled

        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.

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

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

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

      • requestPayer

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

      • requestPayer

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

      • tagging

        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")

        Parameters:
        tagging - The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectLockMode

        PutObjectRequest.Builder objectLockMode​(String objectLockMode)

        The Object Lock mode that you want to apply to this object.

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

      • objectLockMode

        PutObjectRequest.Builder objectLockMode​(ObjectLockMode objectLockMode)

        The Object Lock mode that you want to apply to this object.

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

      • objectLockRetainUntilDate

        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.

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

      • objectLockLegalHoldStatus

        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.

        Parameters:
        objectLockLegalHoldStatus - Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ObjectLockLegalHoldStatus, ObjectLockLegalHoldStatus

      • expectedBucketOwner

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

        Parameters:
        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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.