aws_sdk_wafv2/operation/check_capacity/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::check_capacity::_check_capacity_output::CheckCapacityOutputBuilder;
3
4pub use crate::operation::check_capacity::_check_capacity_input::CheckCapacityInputBuilder;
5
6impl crate::operation::check_capacity::builders::CheckCapacityInputBuilder {
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::check_capacity::CheckCapacityOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::check_capacity::CheckCapacityError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.check_capacity();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CheckCapacity`.
24///
25/// <p>Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a <code>RuleGroup</code> or <code>WebACL</code>.</p>
26/// <p>WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a> in the <i>WAF Developer Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CheckCapacityFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::check_capacity::builders::CheckCapacityInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::check_capacity::CheckCapacityOutput,
36        crate::operation::check_capacity::CheckCapacityError,
37    > for CheckCapacityFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::check_capacity::CheckCapacityOutput,
45            crate::operation::check_capacity::CheckCapacityError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl CheckCapacityFluentBuilder {
52    /// Creates a new `CheckCapacityFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the CheckCapacity as a reference.
61    pub fn as_input(&self) -> &crate::operation::check_capacity::builders::CheckCapacityInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::check_capacity::CheckCapacityOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::check_capacity::CheckCapacityError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::check_capacity::CheckCapacity::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::check_capacity::CheckCapacity::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::check_capacity::CheckCapacityOutput,
98        crate::operation::check_capacity::CheckCapacityError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <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>
113    /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
114    /// <ul>
115    /// <li>
116    /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
117    /// <li>
118    /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
119    /// </ul>
120    pub fn scope(mut self, input: crate::types::Scope) -> Self {
121        self.inner = self.inner.scope(input);
122        self
123    }
124    /// <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>
125    /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
126    /// <ul>
127    /// <li>
128    /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
129    /// <li>
130    /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
131    /// </ul>
132    pub fn set_scope(mut self, input: ::std::option::Option<crate::types::Scope>) -> Self {
133        self.inner = self.inner.set_scope(input);
134        self
135    }
136    /// <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>
137    /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
138    /// <ul>
139    /// <li>
140    /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
141    /// <li>
142    /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
143    /// </ul>
144    pub fn get_scope(&self) -> &::std::option::Option<crate::types::Scope> {
145        self.inner.get_scope()
146    }
147    ///
148    /// Appends an item to `Rules`.
149    ///
150    /// To override the contents of this collection use [`set_rules`](Self::set_rules).
151    ///
152    /// <p>An array of <code>Rule</code> that you're configuring to use in a rule group or web ACL.</p>
153    pub fn rules(mut self, input: crate::types::Rule) -> Self {
154        self.inner = self.inner.rules(input);
155        self
156    }
157    /// <p>An array of <code>Rule</code> that you're configuring to use in a rule group or web ACL.</p>
158    pub fn set_rules(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Rule>>) -> Self {
159        self.inner = self.inner.set_rules(input);
160        self
161    }
162    /// <p>An array of <code>Rule</code> that you're configuring to use in a rule group or web ACL.</p>
163    pub fn get_rules(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Rule>> {
164        self.inner.get_rules()
165    }
166}