aws_sdk_wafv2/operation/update_ip_set/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_ip_set::_update_ip_set_output::UpdateIpSetOutputBuilder;
3
4pub use crate::operation::update_ip_set::_update_ip_set_input::UpdateIpSetInputBuilder;
5
6impl crate::operation::update_ip_set::builders::UpdateIpSetInputBuilder {
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::update_ip_set::UpdateIpSetOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::update_ip_set::UpdateIPSetError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.update_ip_set();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `UpdateIPSet`.
24///
25/// <p>Updates the specified <code>IPSet</code>.</p><note>
26/// <p>This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.</p>
27/// <p>To modify an IP set, do the following:</p>
28/// <ol>
29/// <li>
30/// <p>Retrieve it by calling <code>GetIPSet</code></p></li>
31/// <li>
32/// <p>Update its settings as needed</p></li>
33/// <li>
34/// <p>Provide the complete IP set specification to this call</p></li>
35/// </ol>
36/// </note>
37/// <p><b>Temporary inconsistencies during updates</b></p>
38/// <p>When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.</p>
39/// <p>The following are examples of the temporary inconsistencies that you might notice during change propagation:</p>
40/// <ul>
41/// <li>
42/// <p>After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.</p></li>
43/// <li>
44/// <p>After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.</p></li>
45/// <li>
46/// <p>After you change a rule action setting, you might see the old action in some places and the new action in others.</p></li>
47/// <li>
48/// <p>After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.</p></li>
49/// </ul>
50#[derive(::std::clone::Clone, ::std::fmt::Debug)]
51pub struct UpdateIPSetFluentBuilder {
52 handle: ::std::sync::Arc<crate::client::Handle>,
53 inner: crate::operation::update_ip_set::builders::UpdateIpSetInputBuilder,
54 config_override: ::std::option::Option<crate::config::Builder>,
55}
56impl
57 crate::client::customize::internal::CustomizableSend<
58 crate::operation::update_ip_set::UpdateIpSetOutput,
59 crate::operation::update_ip_set::UpdateIPSetError,
60 > for UpdateIPSetFluentBuilder
61{
62 fn send(
63 self,
64 config_override: crate::config::Builder,
65 ) -> crate::client::customize::internal::BoxFuture<
66 crate::client::customize::internal::SendResult<
67 crate::operation::update_ip_set::UpdateIpSetOutput,
68 crate::operation::update_ip_set::UpdateIPSetError,
69 >,
70 > {
71 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
72 }
73}
74impl UpdateIPSetFluentBuilder {
75 /// Creates a new `UpdateIPSetFluentBuilder`.
76 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
77 Self {
78 handle,
79 inner: ::std::default::Default::default(),
80 config_override: ::std::option::Option::None,
81 }
82 }
83 /// Access the UpdateIPSet as a reference.
84 pub fn as_input(&self) -> &crate::operation::update_ip_set::builders::UpdateIpSetInputBuilder {
85 &self.inner
86 }
87 /// Sends the request and returns the response.
88 ///
89 /// If an error occurs, an `SdkError` will be returned with additional details that
90 /// can be matched against.
91 ///
92 /// By default, any retryable failures will be retried twice. Retry behavior
93 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
94 /// set when configuring the client.
95 pub async fn send(
96 self,
97 ) -> ::std::result::Result<
98 crate::operation::update_ip_set::UpdateIpSetOutput,
99 ::aws_smithy_runtime_api::client::result::SdkError<
100 crate::operation::update_ip_set::UpdateIPSetError,
101 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
102 >,
103 > {
104 let input = self
105 .inner
106 .build()
107 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
108 let runtime_plugins = crate::operation::update_ip_set::UpdateIPSet::operation_runtime_plugins(
109 self.handle.runtime_plugins.clone(),
110 &self.handle.conf,
111 self.config_override,
112 );
113 crate::operation::update_ip_set::UpdateIPSet::orchestrate(&runtime_plugins, input).await
114 }
115
116 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
117 pub fn customize(
118 self,
119 ) -> crate::client::customize::CustomizableOperation<
120 crate::operation::update_ip_set::UpdateIpSetOutput,
121 crate::operation::update_ip_set::UpdateIPSetError,
122 Self,
123 > {
124 crate::client::customize::CustomizableOperation::new(self)
125 }
126 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
127 self.set_config_override(::std::option::Option::Some(config_override.into()));
128 self
129 }
130
131 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
132 self.config_override = config_override;
133 self
134 }
135 /// <p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p>
136 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
137 self.inner = self.inner.name(input.into());
138 self
139 }
140 /// <p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p>
141 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
142 self.inner = self.inner.set_name(input);
143 self
144 }
145 /// <p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p>
146 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
147 self.inner.get_name()
148 }
149 /// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
150 /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
151 /// <ul>
152 /// <li>
153 /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
154 /// <li>
155 /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
156 /// </ul>
157 pub fn scope(mut self, input: crate::types::Scope) -> Self {
158 self.inner = self.inner.scope(input);
159 self
160 }
161 /// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
162 /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
163 /// <ul>
164 /// <li>
165 /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
166 /// <li>
167 /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
168 /// </ul>
169 pub fn set_scope(mut self, input: ::std::option::Option<crate::types::Scope>) -> Self {
170 self.inner = self.inner.set_scope(input);
171 self
172 }
173 /// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
174 /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
175 /// <ul>
176 /// <li>
177 /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
178 /// <li>
179 /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
180 /// </ul>
181 pub fn get_scope(&self) -> &::std::option::Option<crate::types::Scope> {
182 self.inner.get_scope()
183 }
184 /// <p>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>
185 pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
186 self.inner = self.inner.id(input.into());
187 self
188 }
189 /// <p>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>
190 pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
191 self.inner = self.inner.set_id(input);
192 self
193 }
194 /// <p>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>
195 pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
196 self.inner.get_id()
197 }
198 /// <p>A description of the IP set that helps with identification.</p>
199 pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
200 self.inner = self.inner.description(input.into());
201 self
202 }
203 /// <p>A description of the IP set that helps with identification.</p>
204 pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
205 self.inner = self.inner.set_description(input);
206 self
207 }
208 /// <p>A description of the IP set that helps with identification.</p>
209 pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
210 self.inner.get_description()
211 }
212 ///
213 /// Appends an item to `Addresses`.
214 ///
215 /// To override the contents of this collection use [`set_addresses`](Self::set_addresses).
216 ///
217 /// <p>Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for <code>/0</code>.</p>
218 /// <p>Example address strings:</p>
219 /// <ul>
220 /// <li>
221 /// <p>For requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p></li>
222 /// <li>
223 /// <p>For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p></li>
224 /// <li>
225 /// <p>For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p></li>
226 /// <li>
227 /// <p>For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p></li>
228 /// </ul>
229 /// <p>For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>.</p>
230 /// <p>Example JSON <code>Addresses</code> specifications:</p>
231 /// <ul>
232 /// <li>
233 /// <p>Empty array: <code>"Addresses": \[\]</code></p></li>
234 /// <li>
235 /// <p>Array with one address: <code>"Addresses": \["192.0.2.44/32"\]</code></p></li>
236 /// <li>
237 /// <p>Array with three addresses: <code>"Addresses": \["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"\]</code></p></li>
238 /// <li>
239 /// <p>INVALID specification: <code>"Addresses": \[""\]</code> INVALID</p></li>
240 /// </ul>
241 pub fn addresses(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
242 self.inner = self.inner.addresses(input.into());
243 self
244 }
245 /// <p>Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for <code>/0</code>.</p>
246 /// <p>Example address strings:</p>
247 /// <ul>
248 /// <li>
249 /// <p>For requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p></li>
250 /// <li>
251 /// <p>For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p></li>
252 /// <li>
253 /// <p>For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p></li>
254 /// <li>
255 /// <p>For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p></li>
256 /// </ul>
257 /// <p>For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>.</p>
258 /// <p>Example JSON <code>Addresses</code> specifications:</p>
259 /// <ul>
260 /// <li>
261 /// <p>Empty array: <code>"Addresses": \[\]</code></p></li>
262 /// <li>
263 /// <p>Array with one address: <code>"Addresses": \["192.0.2.44/32"\]</code></p></li>
264 /// <li>
265 /// <p>Array with three addresses: <code>"Addresses": \["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"\]</code></p></li>
266 /// <li>
267 /// <p>INVALID specification: <code>"Addresses": \[""\]</code> INVALID</p></li>
268 /// </ul>
269 pub fn set_addresses(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
270 self.inner = self.inner.set_addresses(input);
271 self
272 }
273 /// <p>Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for <code>/0</code>.</p>
274 /// <p>Example address strings:</p>
275 /// <ul>
276 /// <li>
277 /// <p>For requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p></li>
278 /// <li>
279 /// <p>For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p></li>
280 /// <li>
281 /// <p>For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p></li>
282 /// <li>
283 /// <p>For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p></li>
284 /// </ul>
285 /// <p>For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>.</p>
286 /// <p>Example JSON <code>Addresses</code> specifications:</p>
287 /// <ul>
288 /// <li>
289 /// <p>Empty array: <code>"Addresses": \[\]</code></p></li>
290 /// <li>
291 /// <p>Array with one address: <code>"Addresses": \["192.0.2.44/32"\]</code></p></li>
292 /// <li>
293 /// <p>Array with three addresses: <code>"Addresses": \["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"\]</code></p></li>
294 /// <li>
295 /// <p>INVALID specification: <code>"Addresses": \[""\]</code> INVALID</p></li>
296 /// </ul>
297 pub fn get_addresses(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
298 self.inner.get_addresses()
299 }
300 /// <p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p>
301 pub fn lock_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
302 self.inner = self.inner.lock_token(input.into());
303 self
304 }
305 /// <p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p>
306 pub fn set_lock_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
307 self.inner = self.inner.set_lock_token(input);
308 self
309 }
310 /// <p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p>
311 pub fn get_lock_token(&self) -> &::std::option::Option<::std::string::String> {
312 self.inner.get_lock_token()
313 }
314}