/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include <aws/s3/S3_EXPORTS.h> #include <aws/s3/S3Request.h> #include <aws/s3/model/ObjectCannedACL.h> #include <aws/s3/model/AccessControlPolicy.h> #include <aws/core/utils/memory/stl/AWSString.h> #include <aws/s3/model/ChecksumAlgorithm.h> #include <aws/s3/model/RequestPayer.h> #include <aws/core/utils/memory/stl/AWSMap.h> #include <utility> namespace Aws { namespace Http { class URI; } //namespace Http namespace S3 { namespace Model { /** */ class PutObjectAclRequest : public S3Request { public: AWS_S3_API PutObjectAclRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "PutObjectAcl"; } AWS_S3_API Aws::String SerializePayload() const override; AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; AWS_S3_API Aws::String GetChecksumAlgorithmName() const override; /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_S3_API EndpointParameters GetEndpointContextParams() const override; /** * <p>The canned ACL to apply to the object. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned * ACL</a>.</p> */ inline const ObjectCannedACL& GetACL() const{ return m_aCL; } /** * <p>The canned ACL to apply to the object. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned * ACL</a>.</p> */ inline bool ACLHasBeenSet() const { return m_aCLHasBeenSet; } /** * <p>The canned ACL to apply to the object. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned * ACL</a>.</p> */ inline void SetACL(const ObjectCannedACL& value) { m_aCLHasBeenSet = true; m_aCL = value; } /** * <p>The canned ACL to apply to the object. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned * ACL</a>.</p> */ inline void SetACL(ObjectCannedACL&& value) { m_aCLHasBeenSet = true; m_aCL = std::move(value); } /** * <p>The canned ACL to apply to the object. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned * ACL</a>.</p> */ inline PutObjectAclRequest& WithACL(const ObjectCannedACL& value) { SetACL(value); return *this;} /** * <p>The canned ACL to apply to the object. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned * ACL</a>.</p> */ inline PutObjectAclRequest& WithACL(ObjectCannedACL&& value) { SetACL(std::move(value)); return *this;} /** * <p>Contains the elements that set the ACL permissions for an object per * grantee.</p> */ inline const AccessControlPolicy& GetAccessControlPolicy() const{ return m_accessControlPolicy; } /** * <p>Contains the elements that set the ACL permissions for an object per * grantee.</p> */ inline bool AccessControlPolicyHasBeenSet() const { return m_accessControlPolicyHasBeenSet; } /** * <p>Contains the elements that set the ACL permissions for an object per * grantee.</p> */ inline void SetAccessControlPolicy(const AccessControlPolicy& value) { m_accessControlPolicyHasBeenSet = true; m_accessControlPolicy = value; } /** * <p>Contains the elements that set the ACL permissions for an object per * grantee.</p> */ inline void SetAccessControlPolicy(AccessControlPolicy&& value) { m_accessControlPolicyHasBeenSet = true; m_accessControlPolicy = std::move(value); } /** * <p>Contains the elements that set the ACL permissions for an object per * grantee.</p> */ inline PutObjectAclRequest& WithAccessControlPolicy(const AccessControlPolicy& value) { SetAccessControlPolicy(value); return *this;} /** * <p>Contains the elements that set the ACL permissions for an object per * grantee.</p> */ inline PutObjectAclRequest& WithAccessControlPolicy(AccessControlPolicy&& value) { SetAccessControlPolicy(std::move(value)); return *this;} /** * <p>The bucket name that contains the object to which you want to attach the ACL. * </p> <p>When using this action with an access point, you must direct requests to * the access point hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline const Aws::String& GetBucket() const{ return m_bucket; } /** * <p>The bucket name that contains the object to which you want to attach the ACL. * </p> <p>When using this action with an access point, you must direct requests to * the access point hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } /** * <p>The bucket name that contains the object to which you want to attach the ACL. * </p> <p>When using this action with an access point, you must direct requests to * the access point hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; } /** * <p>The bucket name that contains the object to which you want to attach the ACL. * </p> <p>When using this action with an access point, you must direct requests to * the access point hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); } /** * <p>The bucket name that contains the object to which you want to attach the ACL. * </p> <p>When using this action with an access point, you must direct requests to * the access point hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); } /** * <p>The bucket name that contains the object to which you want to attach the ACL. * </p> <p>When using this action with an access point, you must direct requests to * the access point hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline PutObjectAclRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;} /** * <p>The bucket name that contains the object to which you want to attach the ACL. * </p> <p>When using this action with an access point, you must direct requests to * the access point hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline PutObjectAclRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} /** * <p>The bucket name that contains the object to which you want to attach the ACL. * </p> <p>When using this action with an access point, you must direct requests to * the access point hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline PutObjectAclRequest& WithBucket(const char* value) { SetBucket(value); return *this;} /** * <p>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 <a * href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a> </p> <p>For * requests made using the Amazon Web Services Command Line Interface (CLI) or * Amazon Web Services SDKs, this field is calculated automatically.</p> */ inline const Aws::String& GetContentMD5() const{ return m_contentMD5; } /** * <p>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 <a * href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a> </p> <p>For * requests made using the Amazon Web Services Command Line Interface (CLI) or * Amazon Web Services SDKs, this field is calculated automatically.</p> */ inline bool ContentMD5HasBeenSet() const { return m_contentMD5HasBeenSet; } /** * <p>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 <a * href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a> </p> <p>For * requests made using the Amazon Web Services Command Line Interface (CLI) or * Amazon Web Services SDKs, this field is calculated automatically.</p> */ inline void SetContentMD5(const Aws::String& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = value; } /** * <p>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 <a * href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a> </p> <p>For * requests made using the Amazon Web Services Command Line Interface (CLI) or * Amazon Web Services SDKs, this field is calculated automatically.</p> */ inline void SetContentMD5(Aws::String&& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = std::move(value); } /** * <p>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 <a * href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a> </p> <p>For * requests made using the Amazon Web Services Command Line Interface (CLI) or * Amazon Web Services SDKs, this field is calculated automatically.</p> */ inline void SetContentMD5(const char* value) { m_contentMD5HasBeenSet = true; m_contentMD5.assign(value); } /** * <p>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 <a * href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a> </p> <p>For * requests made using the Amazon Web Services Command Line Interface (CLI) or * Amazon Web Services SDKs, this field is calculated automatically.</p> */ inline PutObjectAclRequest& WithContentMD5(const Aws::String& value) { SetContentMD5(value); return *this;} /** * <p>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 <a * href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a> </p> <p>For * requests made using the Amazon Web Services Command Line Interface (CLI) or * Amazon Web Services SDKs, this field is calculated automatically.</p> */ inline PutObjectAclRequest& WithContentMD5(Aws::String&& value) { SetContentMD5(std::move(value)); return *this;} /** * <p>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 <a * href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a> </p> <p>For * requests made using the Amazon Web Services Command Line Interface (CLI) or * Amazon Web Services SDKs, this field is calculated automatically.</p> */ inline PutObjectAclRequest& WithContentMD5(const char* value) { SetContentMD5(value); return *this;} /** * <p>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 * <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad * Request</code>. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking * object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide * an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter.</p> */ inline const ChecksumAlgorithm& GetChecksumAlgorithm() const{ return m_checksumAlgorithm; } /** * <p>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 * <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad * Request</code>. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking * object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide * an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter.</p> */ inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; } /** * <p>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 * <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad * Request</code>. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking * object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide * an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter.</p> */ inline void SetChecksumAlgorithm(const ChecksumAlgorithm& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = value; } /** * <p>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 * <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad * Request</code>. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking * object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide * an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter.</p> */ inline void SetChecksumAlgorithm(ChecksumAlgorithm&& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = std::move(value); } /** * <p>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 * <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad * Request</code>. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking * object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide * an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter.</p> */ inline PutObjectAclRequest& WithChecksumAlgorithm(const ChecksumAlgorithm& value) { SetChecksumAlgorithm(value); return *this;} /** * <p>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 * <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad * Request</code>. For more information, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking * object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide * an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter.</p> */ inline PutObjectAclRequest& WithChecksumAlgorithm(ChecksumAlgorithm&& value) { SetChecksumAlgorithm(std::move(value)); return *this;} /** * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the * bucket.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> */ inline const Aws::String& GetGrantFullControl() const{ return m_grantFullControl; } /** * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the * bucket.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> */ inline bool GrantFullControlHasBeenSet() const { return m_grantFullControlHasBeenSet; } /** * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the * bucket.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> */ inline void SetGrantFullControl(const Aws::String& value) { m_grantFullControlHasBeenSet = true; m_grantFullControl = value; } /** * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the * bucket.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> */ inline void SetGrantFullControl(Aws::String&& value) { m_grantFullControlHasBeenSet = true; m_grantFullControl = std::move(value); } /** * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the * bucket.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> */ inline void SetGrantFullControl(const char* value) { m_grantFullControlHasBeenSet = true; m_grantFullControl.assign(value); } /** * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the * bucket.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantFullControl(const Aws::String& value) { SetGrantFullControl(value); return *this;} /** * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the * bucket.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantFullControl(Aws::String&& value) { SetGrantFullControl(std::move(value)); return *this;} /** * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the * bucket.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantFullControl(const char* value) { SetGrantFullControl(value); return *this;} /** * <p>Allows grantee to list the objects in the bucket.</p> <p>This action is not * supported by Amazon S3 on Outposts.</p> */ inline const Aws::String& GetGrantRead() const{ return m_grantRead; } /** * <p>Allows grantee to list the objects in the bucket.</p> <p>This action is not * supported by Amazon S3 on Outposts.</p> */ inline bool GrantReadHasBeenSet() const { return m_grantReadHasBeenSet; } /** * <p>Allows grantee to list the objects in the bucket.</p> <p>This action is not * supported by Amazon S3 on Outposts.</p> */ inline void SetGrantRead(const Aws::String& value) { m_grantReadHasBeenSet = true; m_grantRead = value; } /** * <p>Allows grantee to list the objects in the bucket.</p> <p>This action is not * supported by Amazon S3 on Outposts.</p> */ inline void SetGrantRead(Aws::String&& value) { m_grantReadHasBeenSet = true; m_grantRead = std::move(value); } /** * <p>Allows grantee to list the objects in the bucket.</p> <p>This action is not * supported by Amazon S3 on Outposts.</p> */ inline void SetGrantRead(const char* value) { m_grantReadHasBeenSet = true; m_grantRead.assign(value); } /** * <p>Allows grantee to list the objects in the bucket.</p> <p>This action is not * supported by Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantRead(const Aws::String& value) { SetGrantRead(value); return *this;} /** * <p>Allows grantee to list the objects in the bucket.</p> <p>This action is not * supported by Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantRead(Aws::String&& value) { SetGrantRead(std::move(value)); return *this;} /** * <p>Allows grantee to list the objects in the bucket.</p> <p>This action is not * supported by Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantRead(const char* value) { SetGrantRead(value); return *this;} /** * <p>Allows grantee to read the bucket ACL.</p> <p>This action is not supported by * Amazon S3 on Outposts.</p> */ inline const Aws::String& GetGrantReadACP() const{ return m_grantReadACP; } /** * <p>Allows grantee to read the bucket ACL.</p> <p>This action is not supported by * Amazon S3 on Outposts.</p> */ inline bool GrantReadACPHasBeenSet() const { return m_grantReadACPHasBeenSet; } /** * <p>Allows grantee to read the bucket ACL.</p> <p>This action is not supported by * Amazon S3 on Outposts.</p> */ inline void SetGrantReadACP(const Aws::String& value) { m_grantReadACPHasBeenSet = true; m_grantReadACP = value; } /** * <p>Allows grantee to read the bucket ACL.</p> <p>This action is not supported by * Amazon S3 on Outposts.</p> */ inline void SetGrantReadACP(Aws::String&& value) { m_grantReadACPHasBeenSet = true; m_grantReadACP = std::move(value); } /** * <p>Allows grantee to read the bucket ACL.</p> <p>This action is not supported by * Amazon S3 on Outposts.</p> */ inline void SetGrantReadACP(const char* value) { m_grantReadACPHasBeenSet = true; m_grantReadACP.assign(value); } /** * <p>Allows grantee to read the bucket ACL.</p> <p>This action is not supported by * Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantReadACP(const Aws::String& value) { SetGrantReadACP(value); return *this;} /** * <p>Allows grantee to read the bucket ACL.</p> <p>This action is not supported by * Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantReadACP(Aws::String&& value) { SetGrantReadACP(std::move(value)); return *this;} /** * <p>Allows grantee to read the bucket ACL.</p> <p>This action is not supported by * Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantReadACP(const char* value) { SetGrantReadACP(value); return *this;} /** * <p>Allows grantee to create new objects in the bucket.</p> <p>For the bucket and * object owners of existing objects, also allows deletions and overwrites of those * objects.</p> */ inline const Aws::String& GetGrantWrite() const{ return m_grantWrite; } /** * <p>Allows grantee to create new objects in the bucket.</p> <p>For the bucket and * object owners of existing objects, also allows deletions and overwrites of those * objects.</p> */ inline bool GrantWriteHasBeenSet() const { return m_grantWriteHasBeenSet; } /** * <p>Allows grantee to create new objects in the bucket.</p> <p>For the bucket and * object owners of existing objects, also allows deletions and overwrites of those * objects.</p> */ inline void SetGrantWrite(const Aws::String& value) { m_grantWriteHasBeenSet = true; m_grantWrite = value; } /** * <p>Allows grantee to create new objects in the bucket.</p> <p>For the bucket and * object owners of existing objects, also allows deletions and overwrites of those * objects.</p> */ inline void SetGrantWrite(Aws::String&& value) { m_grantWriteHasBeenSet = true; m_grantWrite = std::move(value); } /** * <p>Allows grantee to create new objects in the bucket.</p> <p>For the bucket and * object owners of existing objects, also allows deletions and overwrites of those * objects.</p> */ inline void SetGrantWrite(const char* value) { m_grantWriteHasBeenSet = true; m_grantWrite.assign(value); } /** * <p>Allows grantee to create new objects in the bucket.</p> <p>For the bucket and * object owners of existing objects, also allows deletions and overwrites of those * objects.</p> */ inline PutObjectAclRequest& WithGrantWrite(const Aws::String& value) { SetGrantWrite(value); return *this;} /** * <p>Allows grantee to create new objects in the bucket.</p> <p>For the bucket and * object owners of existing objects, also allows deletions and overwrites of those * objects.</p> */ inline PutObjectAclRequest& WithGrantWrite(Aws::String&& value) { SetGrantWrite(std::move(value)); return *this;} /** * <p>Allows grantee to create new objects in the bucket.</p> <p>For the bucket and * object owners of existing objects, also allows deletions and overwrites of those * objects.</p> */ inline PutObjectAclRequest& WithGrantWrite(const char* value) { SetGrantWrite(value); return *this;} /** * <p>Allows grantee to write the ACL for the applicable bucket.</p> <p>This action * is not supported by Amazon S3 on Outposts.</p> */ inline const Aws::String& GetGrantWriteACP() const{ return m_grantWriteACP; } /** * <p>Allows grantee to write the ACL for the applicable bucket.</p> <p>This action * is not supported by Amazon S3 on Outposts.</p> */ inline bool GrantWriteACPHasBeenSet() const { return m_grantWriteACPHasBeenSet; } /** * <p>Allows grantee to write the ACL for the applicable bucket.</p> <p>This action * is not supported by Amazon S3 on Outposts.</p> */ inline void SetGrantWriteACP(const Aws::String& value) { m_grantWriteACPHasBeenSet = true; m_grantWriteACP = value; } /** * <p>Allows grantee to write the ACL for the applicable bucket.</p> <p>This action * is not supported by Amazon S3 on Outposts.</p> */ inline void SetGrantWriteACP(Aws::String&& value) { m_grantWriteACPHasBeenSet = true; m_grantWriteACP = std::move(value); } /** * <p>Allows grantee to write the ACL for the applicable bucket.</p> <p>This action * is not supported by Amazon S3 on Outposts.</p> */ inline void SetGrantWriteACP(const char* value) { m_grantWriteACPHasBeenSet = true; m_grantWriteACP.assign(value); } /** * <p>Allows grantee to write the ACL for the applicable bucket.</p> <p>This action * is not supported by Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantWriteACP(const Aws::String& value) { SetGrantWriteACP(value); return *this;} /** * <p>Allows grantee to write the ACL for the applicable bucket.</p> <p>This action * is not supported by Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantWriteACP(Aws::String&& value) { SetGrantWriteACP(std::move(value)); return *this;} /** * <p>Allows grantee to write the ACL for the applicable bucket.</p> <p>This action * is not supported by Amazon S3 on Outposts.</p> */ inline PutObjectAclRequest& WithGrantWriteACP(const char* value) { SetGrantWriteACP(value); return *this;} /** * <p>Key for which the PUT action was initiated.</p> <p>When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using 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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline const Aws::String& GetKey() const{ return m_key; } /** * <p>Key for which the PUT action was initiated.</p> <p>When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using 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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } /** * <p>Key for which the PUT action was initiated.</p> <p>When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using 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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; } /** * <p>Key for which the PUT action was initiated.</p> <p>When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using 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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } /** * <p>Key for which the PUT action was initiated.</p> <p>When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using 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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); } /** * <p>Key for which the PUT action was initiated.</p> <p>When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using 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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline PutObjectAclRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;} /** * <p>Key for which the PUT action was initiated.</p> <p>When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using 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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline PutObjectAclRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;} /** * <p>Key for which the PUT action was initiated.</p> <p>When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using 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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline PutObjectAclRequest& WithKey(const char* value) { SetKey(value); return *this;} inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; } inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; } inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; } inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); } inline PutObjectAclRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;} inline PutObjectAclRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;} /** * <p>VersionId used to reference a specific version of the object.</p> */ inline const Aws::String& GetVersionId() const{ return m_versionId; } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline PutObjectAclRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;} /** * <p>VersionId used to reference a specific version of the object.</p> */ inline PutObjectAclRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;} /** * <p>VersionId used to reference a specific version of the object.</p> */ inline PutObjectAclRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;} /** * <p>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 <code>403 * Forbidden</code> (access denied).</p> */ inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; } /** * <p>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 <code>403 * Forbidden</code> (access denied).</p> */ inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } /** * <p>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 <code>403 * Forbidden</code> (access denied).</p> */ inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; } /** * <p>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 <code>403 * Forbidden</code> (access denied).</p> */ inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); } /** * <p>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 <code>403 * Forbidden</code> (access denied).</p> */ inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); } /** * <p>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 <code>403 * Forbidden</code> (access denied).</p> */ inline PutObjectAclRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;} /** * <p>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 <code>403 * Forbidden</code> (access denied).</p> */ inline PutObjectAclRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;} /** * <p>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 <code>403 * Forbidden</code> (access denied).</p> */ inline PutObjectAclRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;} inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; } inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; } inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; } inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); } inline PutObjectAclRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;} inline PutObjectAclRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;} inline PutObjectAclRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } inline PutObjectAclRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline PutObjectAclRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline PutObjectAclRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; } inline PutObjectAclRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline PutObjectAclRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline PutObjectAclRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } private: ObjectCannedACL m_aCL; bool m_aCLHasBeenSet = false; AccessControlPolicy m_accessControlPolicy; bool m_accessControlPolicyHasBeenSet = false; Aws::String m_bucket; bool m_bucketHasBeenSet = false; Aws::String m_contentMD5; bool m_contentMD5HasBeenSet = false; ChecksumAlgorithm m_checksumAlgorithm; bool m_checksumAlgorithmHasBeenSet = false; Aws::String m_grantFullControl; bool m_grantFullControlHasBeenSet = false; Aws::String m_grantRead; bool m_grantReadHasBeenSet = false; Aws::String m_grantReadACP; bool m_grantReadACPHasBeenSet = false; Aws::String m_grantWrite; bool m_grantWriteHasBeenSet = false; Aws::String m_grantWriteACP; bool m_grantWriteACPHasBeenSet = false; Aws::String m_key; bool m_keyHasBeenSet = false; RequestPayer m_requestPayer; bool m_requestPayerHasBeenSet = false; Aws::String m_versionId; bool m_versionIdHasBeenSet = false; Aws::String m_expectedBucketOwner; bool m_expectedBucketOwnerHasBeenSet = false; Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag; bool m_customizedAccessLogTagHasBeenSet = false; }; } // namespace Model } // namespace S3 } // namespace Aws