aws_sdk_networkfirewall/operation/describe_rule_group_summary/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_rule_group_summary::_describe_rule_group_summary_output::DescribeRuleGroupSummaryOutputBuilder;
3
4pub use crate::operation::describe_rule_group_summary::_describe_rule_group_summary_input::DescribeRuleGroupSummaryInputBuilder;
5
6impl crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryInputBuilder {
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::describe_rule_group_summary::DescribeRuleGroupSummaryOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_rule_group_summary();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeRuleGroupSummary`.
24///
25/// <p>Returns detailed information for a stateful rule group.</p>
26/// <p>For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.</p>
27/// <p>To modify how threat information appears in summaries, use the <code>SummaryConfiguration</code> parameter in <code>UpdateRuleGroup</code>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct DescribeRuleGroupSummaryFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryOutput,
37        crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryError,
38    > for DescribeRuleGroupSummaryFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryOutput,
46            crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl DescribeRuleGroupSummaryFluentBuilder {
53    /// Creates a new `DescribeRuleGroupSummaryFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the DescribeRuleGroupSummary as a reference.
62    pub fn as_input(&self) -> &crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::describe_rule_group_summary::DescribeRuleGroupSummary::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::describe_rule_group_summary::DescribeRuleGroupSummary::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryOutput,
99        crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
114    /// <p>You must specify the ARN or the name, and you can specify both.</p>
115    pub fn rule_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.inner = self.inner.rule_group_name(input.into());
117        self
118    }
119    /// <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
120    /// <p>You must specify the ARN or the name, and you can specify both.</p>
121    pub fn set_rule_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_rule_group_name(input);
123        self
124    }
125    /// <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
126    /// <p>You must specify the ARN or the name, and you can specify both.</p>
127    pub fn get_rule_group_name(&self) -> &::std::option::Option<::std::string::String> {
128        self.inner.get_rule_group_name()
129    }
130    /// <p>Required. The Amazon Resource Name (ARN) of the rule group.</p>
131    /// <p>You must specify the ARN or the name, and you can specify both.</p>
132    pub fn rule_group_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.rule_group_arn(input.into());
134        self
135    }
136    /// <p>Required. The Amazon Resource Name (ARN) of the rule group.</p>
137    /// <p>You must specify the ARN or the name, and you can specify both.</p>
138    pub fn set_rule_group_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139        self.inner = self.inner.set_rule_group_arn(input);
140        self
141    }
142    /// <p>Required. The Amazon Resource Name (ARN) of the rule group.</p>
143    /// <p>You must specify the ARN or the name, and you can specify both.</p>
144    pub fn get_rule_group_arn(&self) -> &::std::option::Option<::std::string::String> {
145        self.inner.get_rule_group_arn()
146    }
147    /// <p>The type of rule group you want a summary for. This is a required field.</p>
148    /// <p>Valid value: <code>STATEFUL</code></p>
149    /// <p>Note that <code>STATELESS</code> exists but is not currently supported. If you provide <code>STATELESS</code>, an exception is returned.</p>
150    pub fn r#type(mut self, input: crate::types::RuleGroupType) -> Self {
151        self.inner = self.inner.r#type(input);
152        self
153    }
154    /// <p>The type of rule group you want a summary for. This is a required field.</p>
155    /// <p>Valid value: <code>STATEFUL</code></p>
156    /// <p>Note that <code>STATELESS</code> exists but is not currently supported. If you provide <code>STATELESS</code>, an exception is returned.</p>
157    pub fn set_type(mut self, input: ::std::option::Option<crate::types::RuleGroupType>) -> Self {
158        self.inner = self.inner.set_type(input);
159        self
160    }
161    /// <p>The type of rule group you want a summary for. This is a required field.</p>
162    /// <p>Valid value: <code>STATEFUL</code></p>
163    /// <p>Note that <code>STATELESS</code> exists but is not currently supported. If you provide <code>STATELESS</code>, an exception is returned.</p>
164    pub fn get_type(&self) -> &::std::option::Option<crate::types::RuleGroupType> {
165        self.inner.get_type()
166    }
167}
aws_sdk_networkfirewall/operation/describe_rule_group_summary/builders.rs

aws_sdk_networkfirewall/operation/describe_rule_group_summary/
builders.rs
