aws_sdk_iot/operation/create_scheduled_audit/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_scheduled_audit::_create_scheduled_audit_output::CreateScheduledAuditOutputBuilder;
3
4pub use crate::operation::create_scheduled_audit::_create_scheduled_audit_input::CreateScheduledAuditInputBuilder;
5
6impl crate::operation::create_scheduled_audit::builders::CreateScheduledAuditInputBuilder {
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_scheduled_audit::CreateScheduledAuditOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_scheduled_audit::CreateScheduledAuditError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_scheduled_audit();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateScheduledAudit`.
24///
25/// <p>Creates a scheduled audit that is run at a specified time interval.</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">CreateScheduledAudit</a> action.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CreateScheduledAuditFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::create_scheduled_audit::builders::CreateScheduledAuditInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::create_scheduled_audit::CreateScheduledAuditOutput,
36        crate::operation::create_scheduled_audit::CreateScheduledAuditError,
37    > for CreateScheduledAuditFluentBuilder
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_scheduled_audit::CreateScheduledAuditOutput,
45            crate::operation::create_scheduled_audit::CreateScheduledAuditError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl CreateScheduledAuditFluentBuilder {
52    /// Creates a new `CreateScheduledAuditFluentBuilder`.
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 CreateScheduledAudit as a reference.
61    pub fn as_input(&self) -> &crate::operation::create_scheduled_audit::builders::CreateScheduledAuditInputBuilder {
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_scheduled_audit::CreateScheduledAuditOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::create_scheduled_audit::CreateScheduledAuditError,
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_scheduled_audit::CreateScheduledAudit::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::create_scheduled_audit::CreateScheduledAudit::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_scheduled_audit::CreateScheduledAuditOutput,
98        crate::operation::create_scheduled_audit::CreateScheduledAuditError,
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>How often the scheduled audit takes place, either <code>DAILY</code>, <code>WEEKLY</code>, <code>BIWEEKLY</code> or <code>MONTHLY</code>. The start time of each audit is determined by the system.</p>
113    pub fn frequency(mut self, input: crate::types::AuditFrequency) -> Self {
114        self.inner = self.inner.frequency(input);
115        self
116    }
117    /// <p>How often the scheduled audit takes place, either <code>DAILY</code>, <code>WEEKLY</code>, <code>BIWEEKLY</code> or <code>MONTHLY</code>. The start time of each audit is determined by the system.</p>
118    pub fn set_frequency(mut self, input: ::std::option::Option<crate::types::AuditFrequency>) -> Self {
119        self.inner = self.inner.set_frequency(input);
120        self
121    }
122    /// <p>How often the scheduled audit takes place, either <code>DAILY</code>, <code>WEEKLY</code>, <code>BIWEEKLY</code> or <code>MONTHLY</code>. The start time of each audit is determined by the system.</p>
123    pub fn get_frequency(&self) -> &::std::option::Option<crate::types::AuditFrequency> {
124        self.inner.get_frequency()
125    }
126    /// <p>The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to <code>MONTHLY</code>. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the <code>LAST</code> day of the month.</p>
127    pub fn day_of_month(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.day_of_month(input.into());
129        self
130    }
131    /// <p>The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to <code>MONTHLY</code>. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the <code>LAST</code> day of the month.</p>
132    pub fn set_day_of_month(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_day_of_month(input);
134        self
135    }
136    /// <p>The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to <code>MONTHLY</code>. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the <code>LAST</code> day of the month.</p>
137    pub fn get_day_of_month(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_day_of_month()
139    }
140    /// <p>The day of the week on which the scheduled audit takes place, either <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>. This field is required if the <code>frequency</code> parameter is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>
141    pub fn day_of_week(mut self, input: crate::types::DayOfWeek) -> Self {
142        self.inner = self.inner.day_of_week(input);
143        self
144    }
145    /// <p>The day of the week on which the scheduled audit takes place, either <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>. This field is required if the <code>frequency</code> parameter is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>
146    pub fn set_day_of_week(mut self, input: ::std::option::Option<crate::types::DayOfWeek>) -> Self {
147        self.inner = self.inner.set_day_of_week(input);
148        self
149    }
150    /// <p>The day of the week on which the scheduled audit takes place, either <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>. This field is required if the <code>frequency</code> parameter is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>
151    pub fn get_day_of_week(&self) -> &::std::option::Option<crate::types::DayOfWeek> {
152        self.inner.get_day_of_week()
153    }
154    ///
155    /// Appends an item to `targetCheckNames`.
156    ///
157    /// To override the contents of this collection use [`set_target_check_names`](Self::set_target_check_names).
158    ///
159    /// <p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>
160    pub fn target_check_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
161        self.inner = self.inner.target_check_names(input.into());
162        self
163    }
164    /// <p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>
165    pub fn set_target_check_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
166        self.inner = self.inner.set_target_check_names(input);
167        self
168    }
169    /// <p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>
170    pub fn get_target_check_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
171        self.inner.get_target_check_names()
172    }
173    /// <p>The name you want to give to the scheduled audit. (Max. 128 chars)</p>
174    pub fn scheduled_audit_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
175        self.inner = self.inner.scheduled_audit_name(input.into());
176        self
177    }
178    /// <p>The name you want to give to the scheduled audit. (Max. 128 chars)</p>
179    pub fn set_scheduled_audit_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
180        self.inner = self.inner.set_scheduled_audit_name(input);
181        self
182    }
183    /// <p>The name you want to give to the scheduled audit. (Max. 128 chars)</p>
184    pub fn get_scheduled_audit_name(&self) -> &::std::option::Option<::std::string::String> {
185        self.inner.get_scheduled_audit_name()
186    }
187    ///
188    /// Appends an item to `tags`.
189    ///
190    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
191    ///
192    /// <p>Metadata that can be used to manage the scheduled audit.</p>
193    pub fn tags(mut self, input: crate::types::Tag) -> Self {
194        self.inner = self.inner.tags(input);
195        self
196    }
197    /// <p>Metadata that can be used to manage the scheduled audit.</p>
198    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
199        self.inner = self.inner.set_tags(input);
200        self
201    }
202    /// <p>Metadata that can be used to manage the scheduled audit.</p>
203    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
204        self.inner.get_tags()
205    }
206}