Skip to main content

aws_sdk_networksecuritymanager/operation/create_rule/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_rule::_create_rule_input::CreateRuleInputBuilder;
3
4pub use crate::operation::create_rule::_create_rule_output::CreateRuleOutputBuilder;
5
6impl crate::operation::create_rule::builders::CreateRuleInputBuilder {
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_rule::CreateRuleOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_rule::CreateRuleError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_rule();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateRule`.
24///
25/// <p>Creates a rule. A rule defines a network security configuration to enforce, such as an AWS WAF rule group or configuration data. Use <code>isPublished</code> to create the rule in published (<code>ACTIVE</code>) or draft (<code>DRAFT</code>) state.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateRuleFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_rule::builders::CreateRuleInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_rule::CreateRuleOutput,
35        crate::operation::create_rule::CreateRuleError,
36    > for CreateRuleFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::create_rule::CreateRuleOutput,
44            crate::operation::create_rule::CreateRuleError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateRuleFluentBuilder {
51    /// Creates a new `CreateRuleFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the CreateRule as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_rule::builders::CreateRuleInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::create_rule::CreateRuleOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_rule::CreateRuleError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::create_rule::CreateRule::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_rule::CreateRule::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::create_rule::CreateRuleOutput,
97        crate::operation::create_rule::CreateRuleError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>
112    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.client_token(input.into());
114        self
115    }
116    /// <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>
117    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_client_token(input);
119        self
120    }
121    /// <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>
122    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_client_token()
124    }
125    /// <p>The name of the rule.</p>
126    pub fn rule_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.rule_name(input.into());
128        self
129    }
130    /// <p>The name of the rule.</p>
131    pub fn set_rule_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_rule_name(input);
133        self
134    }
135    /// <p>The name of the rule.</p>
136    pub fn get_rule_name(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_rule_name()
138    }
139    /// <p>The firewall type associated with the resource.</p>
140    pub fn firewall_type(mut self, input: crate::types::RuleFirewallType) -> Self {
141        self.inner = self.inner.firewall_type(input);
142        self
143    }
144    /// <p>The firewall type associated with the resource.</p>
145    pub fn set_firewall_type(mut self, input: ::std::option::Option<crate::types::RuleFirewallType>) -> Self {
146        self.inner = self.inner.set_firewall_type(input);
147        self
148    }
149    /// <p>The firewall type associated with the resource.</p>
150    pub fn get_firewall_type(&self) -> &::std::option::Option<crate::types::RuleFirewallType> {
151        self.inner.get_firewall_type()
152    }
153    /// <p>The type of the rule. <code>CONFIGURATION</code> rules contain firewall settings, and <code>INSPECTION</code> rules contain rule groups.</p>
154    pub fn rule_type(mut self, input: crate::types::RuleType) -> Self {
155        self.inner = self.inner.rule_type(input);
156        self
157    }
158    /// <p>The type of the rule. <code>CONFIGURATION</code> rules contain firewall settings, and <code>INSPECTION</code> rules contain rule groups.</p>
159    pub fn set_rule_type(mut self, input: ::std::option::Option<crate::types::RuleType>) -> Self {
160        self.inner = self.inner.set_rule_type(input);
161        self
162    }
163    /// <p>The type of the rule. <code>CONFIGURATION</code> rules contain firewall settings, and <code>INSPECTION</code> rules contain rule groups.</p>
164    pub fn get_rule_type(&self) -> &::std::option::Option<crate::types::RuleType> {
165        self.inner.get_rule_type()
166    }
167    /// <p>A description of the rule.</p>
168    pub fn rule_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
169        self.inner = self.inner.rule_description(input.into());
170        self
171    }
172    /// <p>A description of the rule.</p>
173    pub fn set_rule_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174        self.inner = self.inner.set_rule_description(input);
175        self
176    }
177    /// <p>A description of the rule.</p>
178    pub fn get_rule_description(&self) -> &::std::option::Option<::std::string::String> {
179        self.inner.get_rule_description()
180    }
181    /// <p>The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type. For an AWS WAF <code>INSPECTION</code> rule, provide an AWS WAF rule group. For an AWS WAF <code>CONFIGURATION</code> rule, provide a single web ACL setting, such as <code>DefaultAction</code> or <code>VisibilityConfig</code>; use <code>wafConfigDataType</code> to declare which setting the document contains. For the schema of each setting and complete examples, see <a href="https://docs.aws.amazon.com/network-security-manager/latest/devguide/what-is.html">Writing rule configurations</a> in the <i>AWS Network Security Manager Developer Guide</i>.</p>
182    pub fn configuration(mut self, input: ::aws_smithy_types::Document) -> Self {
183        self.inner = self.inner.configuration(input);
184        self
185    }
186    /// <p>The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type. For an AWS WAF <code>INSPECTION</code> rule, provide an AWS WAF rule group. For an AWS WAF <code>CONFIGURATION</code> rule, provide a single web ACL setting, such as <code>DefaultAction</code> or <code>VisibilityConfig</code>; use <code>wafConfigDataType</code> to declare which setting the document contains. For the schema of each setting and complete examples, see <a href="https://docs.aws.amazon.com/network-security-manager/latest/devguide/what-is.html">Writing rule configurations</a> in the <i>AWS Network Security Manager Developer Guide</i>.</p>
187    pub fn set_configuration(mut self, input: ::std::option::Option<::aws_smithy_types::Document>) -> Self {
188        self.inner = self.inner.set_configuration(input);
189        self
190    }
191    /// <p>The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type. For an AWS WAF <code>INSPECTION</code> rule, provide an AWS WAF rule group. For an AWS WAF <code>CONFIGURATION</code> rule, provide a single web ACL setting, such as <code>DefaultAction</code> or <code>VisibilityConfig</code>; use <code>wafConfigDataType</code> to declare which setting the document contains. For the schema of each setting and complete examples, see <a href="https://docs.aws.amazon.com/network-security-manager/latest/devguide/what-is.html">Writing rule configurations</a> in the <i>AWS Network Security Manager Developer Guide</i>.</p>
192    pub fn get_configuration(&self) -> &::std::option::Option<::aws_smithy_types::Document> {
193        self.inner.get_configuration()
194    }
195    /// <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>
196    pub fn is_published(mut self, input: bool) -> Self {
197        self.inner = self.inner.is_published(input);
198        self
199    }
200    /// <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>
201    pub fn set_is_published(mut self, input: ::std::option::Option<bool>) -> Self {
202        self.inner = self.inner.set_is_published(input);
203        self
204    }
205    /// <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>
206    pub fn get_is_published(&self) -> &::std::option::Option<bool> {
207        self.inner.get_is_published()
208    }
209    ///
210    /// Adds a key-value pair to `tags`.
211    ///
212    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
213    ///
214    /// <p>The tags to add to the resource when it is created.</p>
215    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
216        self.inner = self.inner.tags(k.into(), v.into());
217        self
218    }
219    /// <p>The tags to add to the resource when it is created.</p>
220    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
221        self.inner = self.inner.set_tags(input);
222        self
223    }
224    /// <p>The tags to add to the resource when it is created.</p>
225    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
226        self.inner.get_tags()
227    }
228}