/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace S3 { namespace Model { /** */ class PutBucketPolicyRequest : public StreamingS3Request { public: AWS_S3_API PutBucketPolicyRequest(); // 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 "PutBucketPolicy"; } 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; AWS_S3_API bool IsStreaming() const override { return false; } /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_S3_API EndpointParameters GetEndpointContextParams() const override; /** *

The name of the bucket.

Directory buckets - When you use this * operation with a directory bucket, you must use path-style requests in the * format * https://s3express-control.region_code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. Directory bucket names * must be unique in the chosen Availability Zone. Bucket names must also follow * the format bucket_base_name--az_id--x-s3 (for * example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For * information about bucket naming restrictions, see Directory * bucket naming rules in the Amazon S3 User Guide

*/ inline const Aws::String& GetBucket() const{ return m_bucket; } /** *

The name of the bucket.

Directory buckets - When you use this * operation with a directory bucket, you must use path-style requests in the * format * https://s3express-control.region_code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. Directory bucket names * must be unique in the chosen Availability Zone. Bucket names must also follow * the format bucket_base_name--az_id--x-s3 (for * example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For * information about bucket naming restrictions, see Directory * bucket naming rules in the Amazon S3 User Guide

*/ inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } /** *

The name of the bucket.

Directory buckets - When you use this * operation with a directory bucket, you must use path-style requests in the * format * https://s3express-control.region_code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. Directory bucket names * must be unique in the chosen Availability Zone. Bucket names must also follow * the format bucket_base_name--az_id--x-s3 (for * example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For * information about bucket naming restrictions, see Directory * bucket naming rules in the Amazon S3 User Guide

*/ inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; } /** *

The name of the bucket.

Directory buckets - When you use this * operation with a directory bucket, you must use path-style requests in the * format * https://s3express-control.region_code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. Directory bucket names * must be unique in the chosen Availability Zone. Bucket names must also follow * the format bucket_base_name--az_id--x-s3 (for * example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For * information about bucket naming restrictions, see Directory * bucket naming rules in the Amazon S3 User Guide

*/ inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); } /** *

The name of the bucket.

Directory buckets - When you use this * operation with a directory bucket, you must use path-style requests in the * format * https://s3express-control.region_code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. Directory bucket names * must be unique in the chosen Availability Zone. Bucket names must also follow * the format bucket_base_name--az_id--x-s3 (for * example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For * information about bucket naming restrictions, see Directory * bucket naming rules in the Amazon S3 User Guide

*/ inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); } /** *

The name of the bucket.

Directory buckets - When you use this * operation with a directory bucket, you must use path-style requests in the * format * https://s3express-control.region_code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. Directory bucket names * must be unique in the chosen Availability Zone. Bucket names must also follow * the format bucket_base_name--az_id--x-s3 (for * example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For * information about bucket naming restrictions, see Directory * bucket naming rules in the Amazon S3 User Guide

*/ inline PutBucketPolicyRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;} /** *

The name of the bucket.

Directory buckets - When you use this * operation with a directory bucket, you must use path-style requests in the * format * https://s3express-control.region_code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. Directory bucket names * must be unique in the chosen Availability Zone. Bucket names must also follow * the format bucket_base_name--az_id--x-s3 (for * example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For * information about bucket naming restrictions, see Directory * bucket naming rules in the Amazon S3 User Guide

*/ inline PutBucketPolicyRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} /** *

The name of the bucket.

Directory buckets - When you use this * operation with a directory bucket, you must use path-style requests in the * format * https://s3express-control.region_code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. Directory bucket names * must be unique in the chosen Availability Zone. Bucket names must also follow * the format bucket_base_name--az_id--x-s3 (for * example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For * information about bucket naming restrictions, see Directory * bucket naming rules in the Amazon S3 User Guide

*/ inline PutBucketPolicyRequest& WithBucket(const char* value) { SetBucket(value); return *this;} /** *

The MD5 hash of the request body.

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

This functionality is not * supported for directory buckets.

*/ inline const Aws::String& GetContentMD5() const{ return m_contentMD5; } /** *

The MD5 hash of the request body.

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

This functionality is not * supported for directory buckets.

*/ inline bool ContentMD5HasBeenSet() const { return m_contentMD5HasBeenSet; } /** *

The MD5 hash of the request body.

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

This functionality is not * supported for directory buckets.

*/ inline void SetContentMD5(const Aws::String& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = value; } /** *

The MD5 hash of the request body.

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

This functionality is not * supported for directory buckets.

*/ inline void SetContentMD5(Aws::String&& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = std::move(value); } /** *

The MD5 hash of the request body.

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

This functionality is not * supported for directory buckets.

*/ inline void SetContentMD5(const char* value) { m_contentMD5HasBeenSet = true; m_contentMD5.assign(value); } /** *

The MD5 hash of the request body.

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

This functionality is not * supported for directory buckets.

*/ inline PutBucketPolicyRequest& WithContentMD5(const Aws::String& value) { SetContentMD5(value); return *this;} /** *

The MD5 hash of the request body.

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

This functionality is not * supported for directory buckets.

*/ inline PutBucketPolicyRequest& WithContentMD5(Aws::String&& value) { SetContentMD5(std::move(value)); return *this;} /** *

The MD5 hash of the request body.

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

This functionality is not * supported for directory buckets.

*/ inline PutBucketPolicyRequest& WithContentMD5(const char* value) { SetContentMD5(value); return *this;} /** *

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 or x-amz-trailer * header sent. Otherwise, Amazon S3 fails the request with the HTTP status code * 400 Bad Request.

For the * x-amz-checksum-algorithm header, replace * algorithm 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 through x-amz-sdk-checksum-algorithm, Amazon S3 * ignores any provided ChecksumAlgorithm parameter and uses the * checksum algorithm that matches the provided value in * x-amz-checksum-algorithm .

For directory * buckets, when you use Amazon Web Services SDKs, CRC32 is the * default checksum algorithm that's used for performance.

*/ inline const ChecksumAlgorithm& GetChecksumAlgorithm() const{ return m_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 or x-amz-trailer * header sent. Otherwise, Amazon S3 fails the request with the HTTP status code * 400 Bad Request.

For the * x-amz-checksum-algorithm header, replace * algorithm 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 through x-amz-sdk-checksum-algorithm, Amazon S3 * ignores any provided ChecksumAlgorithm parameter and uses the * checksum algorithm that matches the provided value in * x-amz-checksum-algorithm .

For directory * buckets, when you use Amazon Web Services SDKs, CRC32 is the * default checksum algorithm that's used for performance.

*/ inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; } /** *

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 or x-amz-trailer * header sent. Otherwise, Amazon S3 fails the request with the HTTP status code * 400 Bad Request.

For the * x-amz-checksum-algorithm header, replace * algorithm 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 through x-amz-sdk-checksum-algorithm, Amazon S3 * ignores any provided ChecksumAlgorithm parameter and uses the * checksum algorithm that matches the provided value in * x-amz-checksum-algorithm .

For directory * buckets, when you use Amazon Web Services SDKs, CRC32 is the * default checksum algorithm that's used for performance.

*/ inline void SetChecksumAlgorithm(const ChecksumAlgorithm& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = value; } /** *

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 or x-amz-trailer * header sent. Otherwise, Amazon S3 fails the request with the HTTP status code * 400 Bad Request.

For the * x-amz-checksum-algorithm header, replace * algorithm 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 through x-amz-sdk-checksum-algorithm, Amazon S3 * ignores any provided ChecksumAlgorithm parameter and uses the * checksum algorithm that matches the provided value in * x-amz-checksum-algorithm .

For directory * buckets, when you use Amazon Web Services SDKs, CRC32 is the * default checksum algorithm that's used for performance.

*/ inline void SetChecksumAlgorithm(ChecksumAlgorithm&& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = std::move(value); } /** *

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 or x-amz-trailer * header sent. Otherwise, Amazon S3 fails the request with the HTTP status code * 400 Bad Request.

For the * x-amz-checksum-algorithm header, replace * algorithm 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 through x-amz-sdk-checksum-algorithm, Amazon S3 * ignores any provided ChecksumAlgorithm parameter and uses the * checksum algorithm that matches the provided value in * x-amz-checksum-algorithm .

For directory * buckets, when you use Amazon Web Services SDKs, CRC32 is the * default checksum algorithm that's used for performance.

*/ inline PutBucketPolicyRequest& WithChecksumAlgorithm(const ChecksumAlgorithm& value) { SetChecksumAlgorithm(value); return *this;} /** *

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 or x-amz-trailer * header sent. Otherwise, Amazon S3 fails the request with the HTTP status code * 400 Bad Request.

For the * x-amz-checksum-algorithm header, replace * algorithm 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 through x-amz-sdk-checksum-algorithm, Amazon S3 * ignores any provided ChecksumAlgorithm parameter and uses the * checksum algorithm that matches the provided value in * x-amz-checksum-algorithm .

For directory * buckets, when you use Amazon Web Services SDKs, CRC32 is the * default checksum algorithm that's used for performance.

*/ inline PutBucketPolicyRequest& WithChecksumAlgorithm(ChecksumAlgorithm&& value) { SetChecksumAlgorithm(std::move(value)); return *this;} /** *

Set this parameter to true to confirm that you want to remove your * permissions to change this bucket policy in the future.

This * functionality is not supported for directory buckets.

*/ inline bool GetConfirmRemoveSelfBucketAccess() const{ return m_confirmRemoveSelfBucketAccess; } /** *

Set this parameter to true to confirm that you want to remove your * permissions to change this bucket policy in the future.

This * functionality is not supported for directory buckets.

*/ inline bool ConfirmRemoveSelfBucketAccessHasBeenSet() const { return m_confirmRemoveSelfBucketAccessHasBeenSet; } /** *

Set this parameter to true to confirm that you want to remove your * permissions to change this bucket policy in the future.

This * functionality is not supported for directory buckets.

*/ inline void SetConfirmRemoveSelfBucketAccess(bool value) { m_confirmRemoveSelfBucketAccessHasBeenSet = true; m_confirmRemoveSelfBucketAccess = value; } /** *

Set this parameter to true to confirm that you want to remove your * permissions to change this bucket policy in the future.

This * functionality is not supported for directory buckets.

*/ inline PutBucketPolicyRequest& WithConfirmRemoveSelfBucketAccess(bool value) { SetConfirmRemoveSelfBucketAccess(value); return *this;} /** *

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

*

For directory buckets, this header is not supported in this API operation. If * you specify this header, the request fails with the HTTP status code 501 * Not Implemented.

*/ inline const Aws::String& GetExpectedBucketOwner() const{ return m_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).

*

For directory buckets, this header is not supported in this API operation. If * you specify this header, the request fails with the HTTP status code 501 * Not Implemented.

*/ inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } /** *

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

*

For directory buckets, this header is not supported in this API operation. If * you specify this header, the request fails with the HTTP status code 501 * Not Implemented.

*/ inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; } /** *

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

*

For directory buckets, this header is not supported in this API operation. If * you specify this header, the request fails with the HTTP status code 501 * Not Implemented.

*/ inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); } /** *

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

*

For directory buckets, this header is not supported in this API operation. If * you specify this header, the request fails with the HTTP status code 501 * Not Implemented.

*/ inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); } /** *

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

*

For directory buckets, this header is not supported in this API operation. If * you specify this header, the request fails with the HTTP status code 501 * Not Implemented.

*/ inline PutBucketPolicyRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;} /** *

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

*

For directory buckets, this header is not supported in this API operation. If * you specify this header, the request fails with the HTTP status code 501 * Not Implemented.

*/ inline PutBucketPolicyRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;} /** *

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

*

For directory buckets, this header is not supported in this API operation. If * you specify this header, the request fails with the HTTP status code 501 * Not Implemented.

*/ inline PutBucketPolicyRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;} inline const Aws::Map& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; } inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; } inline void SetCustomizedAccessLogTag(const Aws::Map& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; } inline void SetCustomizedAccessLogTag(Aws::Map&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); } inline PutBucketPolicyRequest& WithCustomizedAccessLogTag(const Aws::Map& value) { SetCustomizedAccessLogTag(value); return *this;} inline PutBucketPolicyRequest& WithCustomizedAccessLogTag(Aws::Map&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;} inline PutBucketPolicyRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } inline PutBucketPolicyRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline PutBucketPolicyRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline PutBucketPolicyRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; } inline PutBucketPolicyRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline PutBucketPolicyRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline PutBucketPolicyRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } private: Aws::String m_bucket; bool m_bucketHasBeenSet = false; Aws::String m_contentMD5; bool m_contentMD5HasBeenSet = false; ChecksumAlgorithm m_checksumAlgorithm; bool m_checksumAlgorithmHasBeenSet = false; bool m_confirmRemoveSelfBucketAccess; bool m_confirmRemoveSelfBucketAccessHasBeenSet = false; Aws::String m_expectedBucketOwner; bool m_expectedBucketOwnerHasBeenSet = false; Aws::Map m_customizedAccessLogTag; bool m_customizedAccessLogTagHasBeenSet = false; }; } // namespace Model } // namespace S3 } // namespace Aws