/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace S3Control { namespace Model { /** */ class PutBucketPolicyRequest : public S3ControlRequest { public: AWS_S3CONTROL_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_S3CONTROL_API Aws::String SerializePayload() const override; AWS_S3CONTROL_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; AWS_S3CONTROL_API inline bool ShouldComputeContentMd5() const override { return true; } /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_S3CONTROL_API EndpointParameters GetEndpointContextParams() const override; /** *

The Amazon Web Services account ID of the Outposts bucket.

*/ inline const Aws::String& GetAccountId() const{ return m_accountId; } /** *

The Amazon Web Services account ID of the Outposts bucket.

*/ inline bool AccountIdHasBeenSet() const { return m_accountIdHasBeenSet; } /** *

The Amazon Web Services account ID of the Outposts bucket.

*/ inline void SetAccountId(const Aws::String& value) { m_accountIdHasBeenSet = true; m_accountId = value; } /** *

The Amazon Web Services account ID of the Outposts bucket.

*/ inline void SetAccountId(Aws::String&& value) { m_accountIdHasBeenSet = true; m_accountId = std::move(value); } /** *

The Amazon Web Services account ID of the Outposts bucket.

*/ inline void SetAccountId(const char* value) { m_accountIdHasBeenSet = true; m_accountId.assign(value); } /** *

The Amazon Web Services account ID of the Outposts bucket.

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

The Amazon Web Services account ID of the Outposts bucket.

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

The Amazon Web Services account ID of the Outposts bucket.

*/ inline PutBucketPolicyRequest& WithAccountId(const char* value) { SetAccountId(value); return *this;} /** *

Specifies the bucket.

For using this parameter with Amazon S3 on * Outposts with the REST API, you must specify the name and the x-amz-outpost-id * as well.

For using this parameter with S3 on Outposts with the Amazon Web * Services SDK and CLI, you must specify the ARN of the bucket accessed in the * format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. * For example, to access the bucket reports through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. * The value must be URL encoded.

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

Specifies the bucket.

For using this parameter with Amazon S3 on * Outposts with the REST API, you must specify the name and the x-amz-outpost-id * as well.

For using this parameter with S3 on Outposts with the Amazon Web * Services SDK and CLI, you must specify the ARN of the bucket accessed in the * format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. * For example, to access the bucket reports through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. * The value must be URL encoded.

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

Specifies the bucket.

For using this parameter with Amazon S3 on * Outposts with the REST API, you must specify the name and the x-amz-outpost-id * as well.

For using this parameter with S3 on Outposts with the Amazon Web * Services SDK and CLI, you must specify the ARN of the bucket accessed in the * format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. * For example, to access the bucket reports through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. * The value must be URL encoded.

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

Specifies the bucket.

For using this parameter with Amazon S3 on * Outposts with the REST API, you must specify the name and the x-amz-outpost-id * as well.

For using this parameter with S3 on Outposts with the Amazon Web * Services SDK and CLI, you must specify the ARN of the bucket accessed in the * format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. * For example, to access the bucket reports through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. * The value must be URL encoded.

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

Specifies the bucket.

For using this parameter with Amazon S3 on * Outposts with the REST API, you must specify the name and the x-amz-outpost-id * as well.

For using this parameter with S3 on Outposts with the Amazon Web * Services SDK and CLI, you must specify the ARN of the bucket accessed in the * format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. * For example, to access the bucket reports through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. * The value must be URL encoded.

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

Specifies the bucket.

For using this parameter with Amazon S3 on * Outposts with the REST API, you must specify the name and the x-amz-outpost-id * as well.

For using this parameter with S3 on Outposts with the Amazon Web * Services SDK and CLI, you must specify the ARN of the bucket accessed in the * format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. * For example, to access the bucket reports through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. * The value must be URL encoded.

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

Specifies the bucket.

For using this parameter with Amazon S3 on * Outposts with the REST API, you must specify the name and the x-amz-outpost-id * as well.

For using this parameter with S3 on Outposts with the Amazon Web * Services SDK and CLI, you must specify the ARN of the bucket accessed in the * format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. * For example, to access the bucket reports through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. * The value must be URL encoded.

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

Specifies the bucket.

For using this parameter with Amazon S3 on * Outposts with the REST API, you must specify the name and the x-amz-outpost-id * as well.

For using this parameter with S3 on Outposts with the Amazon Web * Services SDK and CLI, you must specify the ARN of the bucket accessed in the * format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. * For example, to access the bucket reports through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. * The value must be URL encoded.

*/ inline PutBucketPolicyRequest& WithBucket(const char* value) { SetBucket(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 is * not supported by Amazon S3 on Outposts 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 is * not supported by Amazon S3 on Outposts 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 is * not supported by Amazon S3 on Outposts 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 is * not supported by Amazon S3 on Outposts buckets.

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

The bucket policy as a JSON document.

*/ inline const Aws::String& GetPolicy() const{ return m_policy; } /** *

The bucket policy as a JSON document.

*/ inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; } /** *

The bucket policy as a JSON document.

*/ inline void SetPolicy(const Aws::String& value) { m_policyHasBeenSet = true; m_policy = value; } /** *

The bucket policy as a JSON document.

*/ inline void SetPolicy(Aws::String&& value) { m_policyHasBeenSet = true; m_policy = std::move(value); } /** *

The bucket policy as a JSON document.

*/ inline void SetPolicy(const char* value) { m_policyHasBeenSet = true; m_policy.assign(value); } /** *

The bucket policy as a JSON document.

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

The bucket policy as a JSON document.

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

The bucket policy as a JSON document.

*/ inline PutBucketPolicyRequest& WithPolicy(const char* value) { SetPolicy(value); return *this;} private: Aws::String m_accountId; bool m_accountIdHasBeenSet = false; Aws::String m_bucket; bool m_bucketHasBeenSet = false; bool m_confirmRemoveSelfBucketAccess; bool m_confirmRemoveSelfBucketAccessHasBeenSet = false; Aws::String m_policy; bool m_policyHasBeenSet = false; }; } // namespace Model } // namespace S3Control } // namespace Aws