aws_sdk_waf/operation/create_rate_based_rule/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_rate_based_rule::_create_rate_based_rule_output::CreateRateBasedRuleOutputBuilder;
3
4pub use crate::operation::create_rate_based_rule::_create_rate_based_rule_input::CreateRateBasedRuleInputBuilder;
5
6impl crate::operation::create_rate_based_rule::builders::CreateRateBasedRuleInputBuilder {
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::create_rate_based_rule::CreateRateBasedRuleOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_rate_based_rule::CreateRateBasedRuleError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_rate_based_rule();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateRateBasedRule`.
24///
25/// <note>
26/// <p>This is <b>AWS WAF Classic</b> documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS WAF Classic</a> in the developer guide.</p>
27/// <p><b>For the latest version of AWS WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use.</p>
28/// </note>
29/// <p>Creates a <code>RateBasedRule</code>. The <code>RateBasedRule</code> contains a <code>RateLimit</code>, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The <code>RateBasedRule</code> also contains the <code>IPSet</code> objects, <code>ByteMatchSet</code> objects, and other predicates that identify the requests that you want to count or block if these requests exceed the <code>RateLimit</code>.</p>
30/// <p>If you add more than one predicate to a <code>RateBasedRule</code>, a request not only must exceed the <code>RateLimit</code>, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a <code>RateBasedRule</code>:</p>
31/// <ul>
32/// <li>
33/// <p>An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code></p></li>
34/// <li>
35/// <p>A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header</p></li>
36/// </ul>
37/// <p>Further, you specify a <code>RateLimit</code> of 1,000.</p>
38/// <p>You then add the <code>RateBasedRule</code> to a <code>WebACL</code> and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests.</p>
39/// <p>As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a <code>RateBasedRule</code>:</p>
40/// <ul>
41/// <li>
42/// <p>A <code>ByteMatchSet</code> with <code>FieldToMatch</code> of <code>URI</code></p></li>
43/// <li>
44/// <p>A <code>PositionalConstraint</code> of <code>STARTS_WITH</code></p></li>
45/// <li>
46/// <p>A <code>TargetString</code> of <code>login</code></p></li>
47/// </ul>
48/// <p>Further, you specify a <code>RateLimit</code> of 1,000.</p>
49/// <p>By adding this <code>RateBasedRule</code> to a <code>WebACL</code>, you could limit requests to your login page without affecting the rest of your site.</p>
50/// <p>To create and configure a <code>RateBasedRule</code>, perform the following steps:</p>
51/// <ol>
52/// <li>
53/// <p>Create and update the predicates that you want to include in the rule. For more information, see <code>CreateByteMatchSet</code>, <code>CreateIPSet</code>, and <code>CreateSqlInjectionMatchSet</code>.</p></li>
54/// <li>
55/// <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRule</code> request.</p></li>
56/// <li>
57/// <p>Submit a <code>CreateRateBasedRule</code> request.</p></li>
58/// <li>
59/// <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRule</code> request.</p></li>
60/// <li>
61/// <p>Submit an <code>UpdateRateBasedRule</code> request to specify the predicates that you want to include in the rule.</p></li>
62/// <li>
63/// <p>Create and update a <code>WebACL</code> that contains the <code>RateBasedRule</code>. For more information, see <code>CreateWebACL</code>.</p></li>
64/// </ol>
65/// <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>.</p>
66#[derive(::std::clone::Clone, ::std::fmt::Debug)]
67pub struct CreateRateBasedRuleFluentBuilder {
68 handle: ::std::sync::Arc<crate::client::Handle>,
69 inner: crate::operation::create_rate_based_rule::builders::CreateRateBasedRuleInputBuilder,
70 config_override: ::std::option::Option<crate::config::Builder>,
71}
72impl
73 crate::client::customize::internal::CustomizableSend<
74 crate::operation::create_rate_based_rule::CreateRateBasedRuleOutput,
75 crate::operation::create_rate_based_rule::CreateRateBasedRuleError,
76 > for CreateRateBasedRuleFluentBuilder
77{
78 fn send(
79 self,
80 config_override: crate::config::Builder,
81 ) -> crate::client::customize::internal::BoxFuture<
82 crate::client::customize::internal::SendResult<
83 crate::operation::create_rate_based_rule::CreateRateBasedRuleOutput,
84 crate::operation::create_rate_based_rule::CreateRateBasedRuleError,
85 >,
86 > {
87 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
88 }
89}
90impl CreateRateBasedRuleFluentBuilder {
91 /// Creates a new `CreateRateBasedRuleFluentBuilder`.
92 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
93 Self {
94 handle,
95 inner: ::std::default::Default::default(),
96 config_override: ::std::option::Option::None,
97 }
98 }
99 /// Access the CreateRateBasedRule as a reference.
100 pub fn as_input(&self) -> &crate::operation::create_rate_based_rule::builders::CreateRateBasedRuleInputBuilder {
101 &self.inner
102 }
103 /// Sends the request and returns the response.
104 ///
105 /// If an error occurs, an `SdkError` will be returned with additional details that
106 /// can be matched against.
107 ///
108 /// By default, any retryable failures will be retried twice. Retry behavior
109 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
110 /// set when configuring the client.
111 pub async fn send(
112 self,
113 ) -> ::std::result::Result<
114 crate::operation::create_rate_based_rule::CreateRateBasedRuleOutput,
115 ::aws_smithy_runtime_api::client::result::SdkError<
116 crate::operation::create_rate_based_rule::CreateRateBasedRuleError,
117 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
118 >,
119 > {
120 let input = self
121 .inner
122 .build()
123 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
124 let runtime_plugins = crate::operation::create_rate_based_rule::CreateRateBasedRule::operation_runtime_plugins(
125 self.handle.runtime_plugins.clone(),
126 &self.handle.conf,
127 self.config_override,
128 );
129 crate::operation::create_rate_based_rule::CreateRateBasedRule::orchestrate(&runtime_plugins, input).await
130 }
131
132 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
133 pub fn customize(
134 self,
135 ) -> crate::client::customize::CustomizableOperation<
136 crate::operation::create_rate_based_rule::CreateRateBasedRuleOutput,
137 crate::operation::create_rate_based_rule::CreateRateBasedRuleError,
138 Self,
139 > {
140 crate::client::customize::CustomizableOperation::new(self)
141 }
142 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
143 self.set_config_override(::std::option::Option::Some(config_override.into()));
144 self
145 }
146
147 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
148 self.config_override = config_override;
149 self
150 }
151 /// <p>A friendly name or description of the <code>RateBasedRule</code>. You can't change the name of a <code>RateBasedRule</code> after you create it.</p>
152 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
153 self.inner = self.inner.name(input.into());
154 self
155 }
156 /// <p>A friendly name or description of the <code>RateBasedRule</code>. You can't change the name of a <code>RateBasedRule</code> after you create it.</p>
157 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
158 self.inner = self.inner.set_name(input);
159 self
160 }
161 /// <p>A friendly name or description of the <code>RateBasedRule</code>. You can't change the name of a <code>RateBasedRule</code> after you create it.</p>
162 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
163 self.inner.get_name()
164 }
165 /// <p>A friendly name or description for the metrics for this <code>RateBasedRule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the <code>RateBasedRule</code>.</p>
166 pub fn metric_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
167 self.inner = self.inner.metric_name(input.into());
168 self
169 }
170 /// <p>A friendly name or description for the metrics for this <code>RateBasedRule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the <code>RateBasedRule</code>.</p>
171 pub fn set_metric_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
172 self.inner = self.inner.set_metric_name(input);
173 self
174 }
175 /// <p>A friendly name or description for the metrics for this <code>RateBasedRule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the <code>RateBasedRule</code>.</p>
176 pub fn get_metric_name(&self) -> &::std::option::Option<::std::string::String> {
177 self.inner.get_metric_name()
178 }
179 /// <p>The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for <code>RateKey</code> is <code>IP</code>. <code>IP</code> indicates that requests that arrive from the same IP address are subject to the <code>RateLimit</code> that is specified in the <code>RateBasedRule</code>.</p>
180 pub fn rate_key(mut self, input: crate::types::RateKey) -> Self {
181 self.inner = self.inner.rate_key(input);
182 self
183 }
184 /// <p>The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for <code>RateKey</code> is <code>IP</code>. <code>IP</code> indicates that requests that arrive from the same IP address are subject to the <code>RateLimit</code> that is specified in the <code>RateBasedRule</code>.</p>
185 pub fn set_rate_key(mut self, input: ::std::option::Option<crate::types::RateKey>) -> Self {
186 self.inner = self.inner.set_rate_key(input);
187 self
188 }
189 /// <p>The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for <code>RateKey</code> is <code>IP</code>. <code>IP</code> indicates that requests that arrive from the same IP address are subject to the <code>RateLimit</code> that is specified in the <code>RateBasedRule</code>.</p>
190 pub fn get_rate_key(&self) -> &::std::option::Option<crate::types::RateKey> {
191 self.inner.get_rate_key()
192 }
193 /// <p>The maximum number of requests, which have an identical value in the field that is specified by <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.</p>
194 pub fn rate_limit(mut self, input: i64) -> Self {
195 self.inner = self.inner.rate_limit(input);
196 self
197 }
198 /// <p>The maximum number of requests, which have an identical value in the field that is specified by <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.</p>
199 pub fn set_rate_limit(mut self, input: ::std::option::Option<i64>) -> Self {
200 self.inner = self.inner.set_rate_limit(input);
201 self
202 }
203 /// <p>The maximum number of requests, which have an identical value in the field that is specified by <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.</p>
204 pub fn get_rate_limit(&self) -> &::std::option::Option<i64> {
205 self.inner.get_rate_limit()
206 }
207 /// <p>The <code>ChangeToken</code> that you used to submit the <code>CreateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <code>GetChangeTokenStatus</code>.</p>
208 pub fn change_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
209 self.inner = self.inner.change_token(input.into());
210 self
211 }
212 /// <p>The <code>ChangeToken</code> that you used to submit the <code>CreateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <code>GetChangeTokenStatus</code>.</p>
213 pub fn set_change_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
214 self.inner = self.inner.set_change_token(input);
215 self
216 }
217 /// <p>The <code>ChangeToken</code> that you used to submit the <code>CreateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <code>GetChangeTokenStatus</code>.</p>
218 pub fn get_change_token(&self) -> &::std::option::Option<::std::string::String> {
219 self.inner.get_change_token()
220 }
221 ///
222 /// Appends an item to `Tags`.
223 ///
224 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
225 ///
226 /// <p></p>
227 pub fn tags(mut self, input: crate::types::Tag) -> Self {
228 self.inner = self.inner.tags(input);
229 self
230 }
231 /// <p></p>
232 pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
233 self.inner = self.inner.set_tags(input);
234 self
235 }
236 /// <p></p>
237 pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
238 self.inner.get_tags()
239 }
240}