aws_sdk_s3control/operation/put_bucket_policy/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::put_bucket_policy::_put_bucket_policy_output::PutBucketPolicyOutputBuilder;
3
4pub use crate::operation::put_bucket_policy::_put_bucket_policy_input::PutBucketPolicyInputBuilder;
5
6impl crate::operation::put_bucket_policy::builders::PutBucketPolicyInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::put_bucket_policy::PutBucketPolicyOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::put_bucket_policy::PutBucketPolicyError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.put_bucket_policy();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `PutBucketPolicy`.
24///
25/// <note>
26/// <p>This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html">PutBucketPolicy</a> in the <i>Amazon S3 API Reference</i>.</p>
27/// </note>
28/// <p>Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, 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>
29/// <p>If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the <code>PutBucketPolicy</code> permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.</p>
30/// <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p><important>
31/// <p>As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.</p>
32/// </important>
33/// <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a>.</p>
34/// <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples">Examples</a> section.</p>
35/// <p>The following actions are related to <code>PutBucketPolicy</code>:</p>
36/// <ul>
37/// <li>
38/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html">GetBucketPolicy</a></p></li>
39/// <li>
40/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html">DeleteBucketPolicy</a></p></li>
41/// </ul>
42#[derive(::std::clone::Clone, ::std::fmt::Debug)]
43pub struct PutBucketPolicyFluentBuilder {
44 handle: ::std::sync::Arc<crate::client::Handle>,
45 inner: crate::operation::put_bucket_policy::builders::PutBucketPolicyInputBuilder,
46 config_override: ::std::option::Option<crate::config::Builder>,
47}
48impl
49 crate::client::customize::internal::CustomizableSend<
50 crate::operation::put_bucket_policy::PutBucketPolicyOutput,
51 crate::operation::put_bucket_policy::PutBucketPolicyError,
52 > for PutBucketPolicyFluentBuilder
53{
54 fn send(
55 self,
56 config_override: crate::config::Builder,
57 ) -> crate::client::customize::internal::BoxFuture<
58 crate::client::customize::internal::SendResult<
59 crate::operation::put_bucket_policy::PutBucketPolicyOutput,
60 crate::operation::put_bucket_policy::PutBucketPolicyError,
61 >,
62 > {
63 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
64 }
65}
66impl PutBucketPolicyFluentBuilder {
67 /// Creates a new `PutBucketPolicyFluentBuilder`.
68 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
69 Self {
70 handle,
71 inner: ::std::default::Default::default(),
72 config_override: ::std::option::Option::None,
73 }
74 }
75 /// Access the PutBucketPolicy as a reference.
76 pub fn as_input(&self) -> &crate::operation::put_bucket_policy::builders::PutBucketPolicyInputBuilder {
77 &self.inner
78 }
79 /// Sends the request and returns the response.
80 ///
81 /// If an error occurs, an `SdkError` will be returned with additional details that
82 /// can be matched against.
83 ///
84 /// By default, any retryable failures will be retried twice. Retry behavior
85 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
86 /// set when configuring the client.
87 pub async fn send(
88 self,
89 ) -> ::std::result::Result<
90 crate::operation::put_bucket_policy::PutBucketPolicyOutput,
91 ::aws_smithy_runtime_api::client::result::SdkError<
92 crate::operation::put_bucket_policy::PutBucketPolicyError,
93 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
94 >,
95 > {
96 let input = self
97 .inner
98 .build()
99 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
100 let runtime_plugins = crate::operation::put_bucket_policy::PutBucketPolicy::operation_runtime_plugins(
101 self.handle.runtime_plugins.clone(),
102 &self.handle.conf,
103 self.config_override,
104 );
105 crate::operation::put_bucket_policy::PutBucketPolicy::orchestrate(&runtime_plugins, input).await
106 }
107
108 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
109 pub fn customize(
110 self,
111 ) -> crate::client::customize::CustomizableOperation<
112 crate::operation::put_bucket_policy::PutBucketPolicyOutput,
113 crate::operation::put_bucket_policy::PutBucketPolicyError,
114 Self,
115 > {
116 crate::client::customize::CustomizableOperation::new(self)
117 }
118 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
119 self.set_config_override(::std::option::Option::Some(config_override.into()));
120 self
121 }
122
123 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
124 self.config_override = config_override;
125 self
126 }
127 /// <p>The Amazon Web Services account ID of the Outposts bucket.</p>
128 pub fn account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129 self.inner = self.inner.account_id(input.into());
130 self
131 }
132 /// <p>The Amazon Web Services account ID of the Outposts bucket.</p>
133 pub fn set_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134 self.inner = self.inner.set_account_id(input);
135 self
136 }
137 /// <p>The Amazon Web Services account ID of the Outposts bucket.</p>
138 pub fn get_account_id(&self) -> &::std::option::Option<::std::string::String> {
139 self.inner.get_account_id()
140 }
141 /// <p>Specifies the bucket.</p>
142 /// <p>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.</p>
143 /// <p>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 <code>arn:aws:s3-outposts:<region>
144 /// :
145 /// <account-id>
146 /// :outpost/
147 /// <outpost-id>
148 /// /bucket/
149 /// <my-bucket-name></my-bucket-name>
150 /// </outpost-id>
151 /// </account-id>
152 /// </region></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded.</p>
153 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
154 self.inner = self.inner.bucket(input.into());
155 self
156 }
157 /// <p>Specifies the bucket.</p>
158 /// <p>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.</p>
159 /// <p>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 <code>arn:aws:s3-outposts:<region>
160 /// :
161 /// <account-id>
162 /// :outpost/
163 /// <outpost-id>
164 /// /bucket/
165 /// <my-bucket-name></my-bucket-name>
166 /// </outpost-id>
167 /// </account-id>
168 /// </region></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded.</p>
169 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
170 self.inner = self.inner.set_bucket(input);
171 self
172 }
173 /// <p>Specifies the bucket.</p>
174 /// <p>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.</p>
175 /// <p>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 <code>arn:aws:s3-outposts:<region>
176 /// :
177 /// <account-id>
178 /// :outpost/
179 /// <outpost-id>
180 /// /bucket/
181 /// <my-bucket-name></my-bucket-name>
182 /// </outpost-id>
183 /// </account-id>
184 /// </region></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded.</p>
185 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
186 self.inner.get_bucket()
187 }
188 /// <p>Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.</p><note>
189 /// <p>This is not supported by Amazon S3 on Outposts buckets.</p>
190 /// </note>
191 pub fn confirm_remove_self_bucket_access(mut self, input: bool) -> Self {
192 self.inner = self.inner.confirm_remove_self_bucket_access(input);
193 self
194 }
195 /// <p>Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.</p><note>
196 /// <p>This is not supported by Amazon S3 on Outposts buckets.</p>
197 /// </note>
198 pub fn set_confirm_remove_self_bucket_access(mut self, input: ::std::option::Option<bool>) -> Self {
199 self.inner = self.inner.set_confirm_remove_self_bucket_access(input);
200 self
201 }
202 /// <p>Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.</p><note>
203 /// <p>This is not supported by Amazon S3 on Outposts buckets.</p>
204 /// </note>
205 pub fn get_confirm_remove_self_bucket_access(&self) -> &::std::option::Option<bool> {
206 self.inner.get_confirm_remove_self_bucket_access()
207 }
208 /// <p>The bucket policy as a JSON document.</p>
209 pub fn policy(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
210 self.inner = self.inner.policy(input.into());
211 self
212 }
213 /// <p>The bucket policy as a JSON document.</p>
214 pub fn set_policy(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
215 self.inner = self.inner.set_policy(input);
216 self
217 }
218 /// <p>The bucket policy as a JSON document.</p>
219 pub fn get_policy(&self) -> &::std::option::Option<::std::string::String> {
220 self.inner.get_policy()
221 }
222}