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

Interface PutObjectAclRequest.Builder

    • Method Detail

      • accessControlPolicy

        PutObjectAclRequest.Builder accessControlPolicy​(AccessControlPolicy accessControlPolicy)

        Contains the elements that set the ACL permissions for an object per grantee.

        Parameters:
        accessControlPolicy - Contains the elements that set the ACL permissions for an object per grantee.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • bucket

        PutObjectAclRequest.Builder bucket​(String bucket)

        The bucket name that contains the object to which you want to attach the ACL.

        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.

        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.

        Parameters:
        bucket - The bucket name that contains the object to which you want to attach the ACL.

        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.

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

      • contentMD5

        PutObjectAclRequest.Builder contentMD5​(String contentMD5)

        The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>

        For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

        Parameters:
        contentMD5 - The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>

        For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

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

      • checksumAlgorithm

        PutObjectAclRequest.Builder checksumAlgorithm​(String 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 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 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 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

        PutObjectAclRequest.Builder checksumAlgorithm​(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 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 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 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

      • grantFullControl

        PutObjectAclRequest.Builder grantFullControl​(String grantFullControl)

        Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

        This functionality is not supported for Amazon S3 on Outposts.

        Parameters:
        grantFullControl - Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

        This functionality is not supported for Amazon S3 on Outposts.

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

      • grantRead

        PutObjectAclRequest.Builder grantRead​(String grantRead)

        Allows grantee to list the objects in the bucket.

        This functionality is not supported for Amazon S3 on Outposts.

        Parameters:
        grantRead - Allows grantee to list the objects in the bucket.

        This functionality is not supported for Amazon S3 on Outposts.

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

      • grantReadACP

        PutObjectAclRequest.Builder grantReadACP​(String grantReadACP)

        Allows grantee to read the bucket ACL.

        This functionality is not supported for Amazon S3 on Outposts.

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

        This functionality is not supported for Amazon S3 on Outposts.

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

      • grantWrite

        PutObjectAclRequest.Builder grantWrite​(String grantWrite)

        Allows grantee to create new objects in the bucket.

        For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

        Parameters:
        grantWrite - Allows grantee to create new objects in the bucket.

        For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

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

      • grantWriteACP

        PutObjectAclRequest.Builder grantWriteACP​(String grantWriteACP)

        Allows grantee to write the ACL for the applicable bucket.

        This functionality is not supported for Amazon S3 on Outposts.

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

        This functionality is not supported for Amazon S3 on Outposts.

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

      • key

        PutObjectAclRequest.Builder key​(String key)

        Key for which the PUT action was initiated.

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

      • requestPayer

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

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

      • versionId

        PutObjectAclRequest.Builder versionId​(String versionId)

        Version ID used to reference a specific version of the object.

        This functionality is not supported for directory buckets.

        Parameters:
        versionId - Version ID used to reference a specific version of the object.

        This functionality is not supported for directory buckets.

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

      • expectedBucketOwner

        PutObjectAclRequest.Builder expectedBucketOwner​(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).

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