aws_sdk_iot/operation/create_security_profile/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_security_profile::_create_security_profile_output::CreateSecurityProfileOutputBuilder;
3
4pub use crate::operation::create_security_profile::_create_security_profile_input::CreateSecurityProfileInputBuilder;
5
6impl crate::operation::create_security_profile::builders::CreateSecurityProfileInputBuilder {
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_security_profile::CreateSecurityProfileOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_security_profile::CreateSecurityProfileError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_security_profile();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateSecurityProfile`.
24///
25/// <p>Creates a Device Defender security profile.</p>
26/// <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateSecurityProfile</a> action.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CreateSecurityProfileFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::create_security_profile::builders::CreateSecurityProfileInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::create_security_profile::CreateSecurityProfileOutput,
36        crate::operation::create_security_profile::CreateSecurityProfileError,
37    > for CreateSecurityProfileFluentBuilder
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::create_security_profile::CreateSecurityProfileOutput,
45            crate::operation::create_security_profile::CreateSecurityProfileError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl CreateSecurityProfileFluentBuilder {
52    /// Creates a new `CreateSecurityProfileFluentBuilder`.
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 CreateSecurityProfile as a reference.
61    pub fn as_input(&self) -> &crate::operation::create_security_profile::builders::CreateSecurityProfileInputBuilder {
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::create_security_profile::CreateSecurityProfileOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::create_security_profile::CreateSecurityProfileError,
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::create_security_profile::CreateSecurityProfile::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::create_security_profile::CreateSecurityProfile::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::create_security_profile::CreateSecurityProfileOutput,
98        crate::operation::create_security_profile::CreateSecurityProfileError,
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>The name you are giving to the security profile.</p>
113    pub fn security_profile_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.security_profile_name(input.into());
115        self
116    }
117    /// <p>The name you are giving to the security profile.</p>
118    pub fn set_security_profile_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_security_profile_name(input);
120        self
121    }
122    /// <p>The name you are giving to the security profile.</p>
123    pub fn get_security_profile_name(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_security_profile_name()
125    }
126    /// <p>A description of the security profile.</p>
127    pub fn security_profile_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.security_profile_description(input.into());
129        self
130    }
131    /// <p>A description of the security profile.</p>
132    pub fn set_security_profile_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_security_profile_description(input);
134        self
135    }
136    /// <p>A description of the security profile.</p>
137    pub fn get_security_profile_description(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_security_profile_description()
139    }
140    ///
141    /// Appends an item to `behaviors`.
142    ///
143    /// To override the contents of this collection use [`set_behaviors`](Self::set_behaviors).
144    ///
145    /// <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
146    pub fn behaviors(mut self, input: crate::types::Behavior) -> Self {
147        self.inner = self.inner.behaviors(input);
148        self
149    }
150    /// <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
151    pub fn set_behaviors(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Behavior>>) -> Self {
152        self.inner = self.inner.set_behaviors(input);
153        self
154    }
155    /// <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
156    pub fn get_behaviors(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Behavior>> {
157        self.inner.get_behaviors()
158    }
159    ///
160    /// Adds a key-value pair to `alertTargets`.
161    ///
162    /// To override the contents of this collection use [`set_alert_targets`](Self::set_alert_targets).
163    ///
164    /// <p>Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.</p>
165    pub fn alert_targets(mut self, k: crate::types::AlertTargetType, v: crate::types::AlertTarget) -> Self {
166        self.inner = self.inner.alert_targets(k, v);
167        self
168    }
169    /// <p>Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.</p>
170    pub fn set_alert_targets(
171        mut self,
172        input: ::std::option::Option<::std::collections::HashMap<crate::types::AlertTargetType, crate::types::AlertTarget>>,
173    ) -> Self {
174        self.inner = self.inner.set_alert_targets(input);
175        self
176    }
177    /// <p>Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.</p>
178    pub fn get_alert_targets(&self) -> &::std::option::Option<::std::collections::HashMap<crate::types::AlertTargetType, crate::types::AlertTarget>> {
179        self.inner.get_alert_targets()
180    }
181    ///
182    /// Appends an item to `additionalMetricsToRetain`.
183    ///
184    /// To override the contents of this collection use [`set_additional_metrics_to_retain`](Self::set_additional_metrics_to_retain).
185    ///
186    /// <p><i>Please use <code>CreateSecurityProfileRequest$additionalMetricsToRetainV2</code> instead.</i></p>
187    /// <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
188    #[deprecated(note = "Use additionalMetricsToRetainV2.")]
189    pub fn additional_metrics_to_retain(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
190        self.inner = self.inner.additional_metrics_to_retain(input.into());
191        self
192    }
193    /// <p><i>Please use <code>CreateSecurityProfileRequest$additionalMetricsToRetainV2</code> instead.</i></p>
194    /// <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
195    #[deprecated(note = "Use additionalMetricsToRetainV2.")]
196    pub fn set_additional_metrics_to_retain(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
197        self.inner = self.inner.set_additional_metrics_to_retain(input);
198        self
199    }
200    /// <p><i>Please use <code>CreateSecurityProfileRequest$additionalMetricsToRetainV2</code> instead.</i></p>
201    /// <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
202    #[deprecated(note = "Use additionalMetricsToRetainV2.")]
203    pub fn get_additional_metrics_to_retain(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
204        self.inner.get_additional_metrics_to_retain()
205    }
206    ///
207    /// Appends an item to `additionalMetricsToRetainV2`.
208    ///
209    /// To override the contents of this collection use [`set_additional_metrics_to_retain_v2`](Self::set_additional_metrics_to_retain_v2).
210    ///
211    /// <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
212    pub fn additional_metrics_to_retain_v2(mut self, input: crate::types::MetricToRetain) -> Self {
213        self.inner = self.inner.additional_metrics_to_retain_v2(input);
214        self
215    }
216    /// <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
217    pub fn set_additional_metrics_to_retain_v2(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::MetricToRetain>>) -> Self {
218        self.inner = self.inner.set_additional_metrics_to_retain_v2(input);
219        self
220    }
221    /// <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
222    pub fn get_additional_metrics_to_retain_v2(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::MetricToRetain>> {
223        self.inner.get_additional_metrics_to_retain_v2()
224    }
225    ///
226    /// Appends an item to `tags`.
227    ///
228    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
229    ///
230    /// <p>Metadata that can be used to manage the security profile.</p>
231    pub fn tags(mut self, input: crate::types::Tag) -> Self {
232        self.inner = self.inner.tags(input);
233        self
234    }
235    /// <p>Metadata that can be used to manage the security profile.</p>
236    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
237        self.inner = self.inner.set_tags(input);
238        self
239    }
240    /// <p>Metadata that can be used to manage the security profile.</p>
241    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
242        self.inner.get_tags()
243    }
244    /// <p>Specifies the MQTT topic and role ARN required for metric export.</p>
245    pub fn metrics_export_config(mut self, input: crate::types::MetricsExportConfig) -> Self {
246        self.inner = self.inner.metrics_export_config(input);
247        self
248    }
249    /// <p>Specifies the MQTT topic and role ARN required for metric export.</p>
250    pub fn set_metrics_export_config(mut self, input: ::std::option::Option<crate::types::MetricsExportConfig>) -> Self {
251        self.inner = self.inner.set_metrics_export_config(input);
252        self
253    }
254    /// <p>Specifies the MQTT topic and role ARN required for metric export.</p>
255    pub fn get_metrics_export_config(&self) -> &::std::option::Option<crate::types::MetricsExportConfig> {
256        self.inner.get_metrics_export_config()
257    }
258}
aws_sdk_iot/operation/create_security_profile/builders.rs

aws_sdk_iot/operation/create_security_profile/
builders.rs
