aws_sdk_cloudwatchlogs/operation/create_scheduled_query/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_scheduled_query::_create_scheduled_query_output::CreateScheduledQueryOutputBuilder;
3
4pub use crate::operation::create_scheduled_query::_create_scheduled_query_input::CreateScheduledQueryInputBuilder;
5
6impl crate::operation::create_scheduled_query::builders::CreateScheduledQueryInputBuilder {
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_query::CreateScheduledQueryOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_scheduled_query::CreateScheduledQueryError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_scheduled_query();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateScheduledQuery`.
24///
25/// <p>Creates a scheduled query that runs CloudWatch Logs Insights queries at regular intervals. Scheduled queries enable proactive monitoring by automatically executing queries to detect patterns and anomalies in your log data. Query results can be delivered to Amazon S3 for analysis or further processing.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateScheduledQueryFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_scheduled_query::builders::CreateScheduledQueryInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_scheduled_query::CreateScheduledQueryOutput,
35        crate::operation::create_scheduled_query::CreateScheduledQueryError,
36    > for CreateScheduledQueryFluentBuilder
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_scheduled_query::CreateScheduledQueryOutput,
44            crate::operation::create_scheduled_query::CreateScheduledQueryError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateScheduledQueryFluentBuilder {
51    /// Creates a new `CreateScheduledQueryFluentBuilder`.
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 CreateScheduledQuery as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_scheduled_query::builders::CreateScheduledQueryInputBuilder {
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_scheduled_query::CreateScheduledQueryOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_scheduled_query::CreateScheduledQueryError,
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_scheduled_query::CreateScheduledQuery::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_scheduled_query::CreateScheduledQuery::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_scheduled_query::CreateScheduledQueryOutput,
97        crate::operation::create_scheduled_query::CreateScheduledQueryError,
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>The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.</p>
112    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.name(input.into());
114        self
115    }
116    /// <p>The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.</p>
117    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_name(input);
119        self
120    }
121    /// <p>The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.</p>
122    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_name()
124    }
125    /// <p>An optional description for the scheduled query to help identify its purpose and functionality.</p>
126    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.description(input.into());
128        self
129    }
130    /// <p>An optional description for the scheduled query to help identify its purpose and functionality.</p>
131    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_description(input);
133        self
134    }
135    /// <p>An optional description for the scheduled query to help identify its purpose and functionality.</p>
136    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_description()
138    }
139    /// <p>The query language to use for the scheduled query. Valid values are <code>LogsQL</code>, <code>PPL</code>, and <code>SQL</code>.</p>
140    pub fn query_language(mut self, input: crate::types::QueryLanguage) -> Self {
141        self.inner = self.inner.query_language(input);
142        self
143    }
144    /// <p>The query language to use for the scheduled query. Valid values are <code>LogsQL</code>, <code>PPL</code>, and <code>SQL</code>.</p>
145    pub fn set_query_language(mut self, input: ::std::option::Option<crate::types::QueryLanguage>) -> Self {
146        self.inner = self.inner.set_query_language(input);
147        self
148    }
149    /// <p>The query language to use for the scheduled query. Valid values are <code>LogsQL</code>, <code>PPL</code>, and <code>SQL</code>.</p>
150    pub fn get_query_language(&self) -> &::std::option::Option<crate::types::QueryLanguage> {
151        self.inner.get_query_language()
152    }
153    /// <p>The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.</p>
154    pub fn query_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.query_string(input.into());
156        self
157    }
158    /// <p>The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.</p>
159    pub fn set_query_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_query_string(input);
161        self
162    }
163    /// <p>The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.</p>
164    pub fn get_query_string(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_query_string()
166    }
167    ///
168    /// Appends an item to `logGroupIdentifiers`.
169    ///
170    /// To override the contents of this collection use [`set_log_group_identifiers`](Self::set_log_group_identifiers).
171    ///
172    /// <p>An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.</p>
173    pub fn log_group_identifiers(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
174        self.inner = self.inner.log_group_identifiers(input.into());
175        self
176    }
177    /// <p>An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.</p>
178    pub fn set_log_group_identifiers(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
179        self.inner = self.inner.set_log_group_identifiers(input);
180        self
181    }
182    /// <p>An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.</p>
183    pub fn get_log_group_identifiers(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
184        self.inner.get_log_group_identifiers()
185    }
186    /// <p>A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.</p>
187    pub fn schedule_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
188        self.inner = self.inner.schedule_expression(input.into());
189        self
190    }
191    /// <p>A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.</p>
192    pub fn set_schedule_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
193        self.inner = self.inner.set_schedule_expression(input);
194        self
195    }
196    /// <p>A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.</p>
197    pub fn get_schedule_expression(&self) -> &::std::option::Option<::std::string::String> {
198        self.inner.get_schedule_expression()
199    }
200    /// <p>The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.</p>
201    pub fn timezone(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
202        self.inner = self.inner.timezone(input.into());
203        self
204    }
205    /// <p>The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.</p>
206    pub fn set_timezone(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
207        self.inner = self.inner.set_timezone(input);
208        self
209    }
210    /// <p>The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.</p>
211    pub fn get_timezone(&self) -> &::std::option::Option<::std::string::String> {
212        self.inner.get_timezone()
213    }
214    /// <p>The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.</p>
215    pub fn start_time_offset(mut self, input: i64) -> Self {
216        self.inner = self.inner.start_time_offset(input);
217        self
218    }
219    /// <p>The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.</p>
220    pub fn set_start_time_offset(mut self, input: ::std::option::Option<i64>) -> Self {
221        self.inner = self.inner.set_start_time_offset(input);
222        self
223    }
224    /// <p>The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.</p>
225    pub fn get_start_time_offset(&self) -> &::std::option::Option<i64> {
226        self.inner.get_start_time_offset()
227    }
228    /// <p>Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.</p>
229    pub fn destination_configuration(mut self, input: crate::types::DestinationConfiguration) -> Self {
230        self.inner = self.inner.destination_configuration(input);
231        self
232    }
233    /// <p>Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.</p>
234    pub fn set_destination_configuration(mut self, input: ::std::option::Option<crate::types::DestinationConfiguration>) -> Self {
235        self.inner = self.inner.set_destination_configuration(input);
236        self
237    }
238    /// <p>Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.</p>
239    pub fn get_destination_configuration(&self) -> &::std::option::Option<crate::types::DestinationConfiguration> {
240        self.inner.get_destination_configuration()
241    }
242    /// <p>The start time for the scheduled query in Unix epoch format. The query will not execute before this time.</p>
243    pub fn schedule_start_time(mut self, input: i64) -> Self {
244        self.inner = self.inner.schedule_start_time(input);
245        self
246    }
247    /// <p>The start time for the scheduled query in Unix epoch format. The query will not execute before this time.</p>
248    pub fn set_schedule_start_time(mut self, input: ::std::option::Option<i64>) -> Self {
249        self.inner = self.inner.set_schedule_start_time(input);
250        self
251    }
252    /// <p>The start time for the scheduled query in Unix epoch format. The query will not execute before this time.</p>
253    pub fn get_schedule_start_time(&self) -> &::std::option::Option<i64> {
254        self.inner.get_schedule_start_time()
255    }
256    /// <p>The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.</p>
257    pub fn schedule_end_time(mut self, input: i64) -> Self {
258        self.inner = self.inner.schedule_end_time(input);
259        self
260    }
261    /// <p>The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.</p>
262    pub fn set_schedule_end_time(mut self, input: ::std::option::Option<i64>) -> Self {
263        self.inner = self.inner.set_schedule_end_time(input);
264        self
265    }
266    /// <p>The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.</p>
267    pub fn get_schedule_end_time(&self) -> &::std::option::Option<i64> {
268        self.inner.get_schedule_end_time()
269    }
270    /// <p>The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.</p>
271    pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
272        self.inner = self.inner.execution_role_arn(input.into());
273        self
274    }
275    /// <p>The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.</p>
276    pub fn set_execution_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
277        self.inner = self.inner.set_execution_role_arn(input);
278        self
279    }
280    /// <p>The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.</p>
281    pub fn get_execution_role_arn(&self) -> &::std::option::Option<::std::string::String> {
282        self.inner.get_execution_role_arn()
283    }
284    /// <p>The initial state of the scheduled query. Valid values are <code>ENABLED</code> and <code>DISABLED</code>. Default is <code>ENABLED</code>.</p>
285    pub fn state(mut self, input: crate::types::ScheduledQueryState) -> Self {
286        self.inner = self.inner.state(input);
287        self
288    }
289    /// <p>The initial state of the scheduled query. Valid values are <code>ENABLED</code> and <code>DISABLED</code>. Default is <code>ENABLED</code>.</p>
290    pub fn set_state(mut self, input: ::std::option::Option<crate::types::ScheduledQueryState>) -> Self {
291        self.inner = self.inner.set_state(input);
292        self
293    }
294    /// <p>The initial state of the scheduled query. Valid values are <code>ENABLED</code> and <code>DISABLED</code>. Default is <code>ENABLED</code>.</p>
295    pub fn get_state(&self) -> &::std::option::Option<crate::types::ScheduledQueryState> {
296        self.inner.get_state()
297    }
298    ///
299    /// Adds a key-value pair to `tags`.
300    ///
301    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
302    ///
303    /// <p>Key-value pairs to associate with the scheduled query for resource management and cost allocation.</p>
304    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
305        self.inner = self.inner.tags(k.into(), v.into());
306        self
307    }
308    /// <p>Key-value pairs to associate with the scheduled query for resource management and cost allocation.</p>
309    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
310        self.inner = self.inner.set_tags(input);
311        self
312    }
313    /// <p>Key-value pairs to associate with the scheduled query for resource management and cost allocation.</p>
314    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
315        self.inner.get_tags()
316    }
317}
aws_sdk_cloudwatchlogs/operation/create_scheduled_query/builders.rs

aws_sdk_cloudwatchlogs/operation/create_scheduled_query/
builders.rs
