1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateScheduledQueryInput {
/// <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>
pub name: ::std::option::Option<::std::string::String>,
/// <p>An optional description for the scheduled query to help identify its purpose and functionality.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The query language to use for the scheduled query. Valid values are <code>CWLI</code>, <code>PPL</code>, and <code>SQL</code>.</p>
pub query_language: ::std::option::Option<crate::types::QueryLanguage>,
/// <p>The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.</p>
pub query_string: ::std::option::Option<::std::string::String>,
/// <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>
pub log_group_identifiers: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <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>
pub schedule_expression: ::std::option::Option<::std::string::String>,
/// <p>The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.</p>
pub timezone: ::std::option::Option<::std::string::String>,
/// <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>
pub start_time_offset: ::std::option::Option<i64>,
/// <p>Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.</p>
pub destination_configuration: ::std::option::Option<crate::types::DestinationConfiguration>,
/// <p>The start time for the scheduled query in Unix epoch format. The query will not execute before this time.</p>
pub schedule_start_time: ::std::option::Option<i64>,
/// <p>The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.</p>
pub schedule_end_time: ::std::option::Option<i64>,
/// <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>
pub execution_role_arn: ::std::option::Option<::std::string::String>,
/// <p>The initial state of the scheduled query. Valid values are <code>ENABLED</code> and <code>DISABLED</code>. Default is <code>ENABLED</code>.</p>
pub state: ::std::option::Option<crate::types::ScheduledQueryState>,
/// <p>Key-value pairs to associate with the scheduled query for resource management and cost allocation.</p>
pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreateScheduledQueryInput {
/// <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>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>An optional description for the scheduled query to help identify its purpose and functionality.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The query language to use for the scheduled query. Valid values are <code>CWLI</code>, <code>PPL</code>, and <code>SQL</code>.</p>
pub fn query_language(&self) -> ::std::option::Option<&crate::types::QueryLanguage> {
self.query_language.as_ref()
}
/// <p>The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.</p>
pub fn query_string(&self) -> ::std::option::Option<&str> {
self.query_string.as_deref()
}
/// <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>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.log_group_identifiers.is_none()`.
pub fn log_group_identifiers(&self) -> &[::std::string::String] {
self.log_group_identifiers.as_deref().unwrap_or_default()
}
/// <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>
pub fn schedule_expression(&self) -> ::std::option::Option<&str> {
self.schedule_expression.as_deref()
}
/// <p>The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.</p>
pub fn timezone(&self) -> ::std::option::Option<&str> {
self.timezone.as_deref()
}
/// <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>
pub fn start_time_offset(&self) -> ::std::option::Option<i64> {
self.start_time_offset
}
/// <p>Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.</p>
pub fn destination_configuration(&self) -> ::std::option::Option<&crate::types::DestinationConfiguration> {
self.destination_configuration.as_ref()
}
/// <p>The start time for the scheduled query in Unix epoch format. The query will not execute before this time.</p>
pub fn schedule_start_time(&self) -> ::std::option::Option<i64> {
self.schedule_start_time
}
/// <p>The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.</p>
pub fn schedule_end_time(&self) -> ::std::option::Option<i64> {
self.schedule_end_time
}
/// <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>
pub fn execution_role_arn(&self) -> ::std::option::Option<&str> {
self.execution_role_arn.as_deref()
}
/// <p>The initial state of the scheduled query. Valid values are <code>ENABLED</code> and <code>DISABLED</code>. Default is <code>ENABLED</code>.</p>
pub fn state(&self) -> ::std::option::Option<&crate::types::ScheduledQueryState> {
self.state.as_ref()
}
/// <p>Key-value pairs to associate with the scheduled query for resource management and cost allocation.</p>
pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.tags.as_ref()
}
}
impl CreateScheduledQueryInput {
/// Creates a new builder-style object to manufacture [`CreateScheduledQueryInput`](crate::operation::create_scheduled_query::CreateScheduledQueryInput).
pub fn builder() -> crate::operation::create_scheduled_query::builders::CreateScheduledQueryInputBuilder {
crate::operation::create_scheduled_query::builders::CreateScheduledQueryInputBuilder::default()
}
}
/// A builder for [`CreateScheduledQueryInput`](crate::operation::create_scheduled_query::CreateScheduledQueryInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateScheduledQueryInputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) query_language: ::std::option::Option<crate::types::QueryLanguage>,
pub(crate) query_string: ::std::option::Option<::std::string::String>,
pub(crate) log_group_identifiers: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) schedule_expression: ::std::option::Option<::std::string::String>,
pub(crate) timezone: ::std::option::Option<::std::string::String>,
pub(crate) start_time_offset: ::std::option::Option<i64>,
pub(crate) destination_configuration: ::std::option::Option<crate::types::DestinationConfiguration>,
pub(crate) schedule_start_time: ::std::option::Option<i64>,
pub(crate) schedule_end_time: ::std::option::Option<i64>,
pub(crate) execution_role_arn: ::std::option::Option<::std::string::String>,
pub(crate) state: ::std::option::Option<crate::types::ScheduledQueryState>,
pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreateScheduledQueryInputBuilder {
/// <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>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <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>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <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>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>An optional description for the scheduled query to help identify its purpose and functionality.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>An optional description for the scheduled query to help identify its purpose and functionality.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>An optional description for the scheduled query to help identify its purpose and functionality.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The query language to use for the scheduled query. Valid values are <code>CWLI</code>, <code>PPL</code>, and <code>SQL</code>.</p>
/// This field is required.
pub fn query_language(mut self, input: crate::types::QueryLanguage) -> Self {
self.query_language = ::std::option::Option::Some(input);
self
}
/// <p>The query language to use for the scheduled query. Valid values are <code>CWLI</code>, <code>PPL</code>, and <code>SQL</code>.</p>
pub fn set_query_language(mut self, input: ::std::option::Option<crate::types::QueryLanguage>) -> Self {
self.query_language = input;
self
}
/// <p>The query language to use for the scheduled query. Valid values are <code>CWLI</code>, <code>PPL</code>, and <code>SQL</code>.</p>
pub fn get_query_language(&self) -> &::std::option::Option<crate::types::QueryLanguage> {
&self.query_language
}
/// <p>The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.</p>
/// This field is required.
pub fn query_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.query_string = ::std::option::Option::Some(input.into());
self
}
/// <p>The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.</p>
pub fn set_query_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.query_string = input;
self
}
/// <p>The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.</p>
pub fn get_query_string(&self) -> &::std::option::Option<::std::string::String> {
&self.query_string
}
/// Appends an item to `log_group_identifiers`.
///
/// To override the contents of this collection use [`set_log_group_identifiers`](Self::set_log_group_identifiers).
///
/// <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>
pub fn log_group_identifiers(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.log_group_identifiers.unwrap_or_default();
v.push(input.into());
self.log_group_identifiers = ::std::option::Option::Some(v);
self
}
/// <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>
pub fn set_log_group_identifiers(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.log_group_identifiers = input;
self
}
/// <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>
pub fn get_log_group_identifiers(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.log_group_identifiers
}
/// <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>
/// This field is required.
pub fn schedule_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.schedule_expression = ::std::option::Option::Some(input.into());
self
}
/// <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>
pub fn set_schedule_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.schedule_expression = input;
self
}
/// <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>
pub fn get_schedule_expression(&self) -> &::std::option::Option<::std::string::String> {
&self.schedule_expression
}
/// <p>The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.</p>
pub fn timezone(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.timezone = ::std::option::Option::Some(input.into());
self
}
/// <p>The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.</p>
pub fn set_timezone(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.timezone = input;
self
}
/// <p>The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.</p>
pub fn get_timezone(&self) -> &::std::option::Option<::std::string::String> {
&self.timezone
}
/// <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>
pub fn start_time_offset(mut self, input: i64) -> Self {
self.start_time_offset = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_start_time_offset(mut self, input: ::std::option::Option<i64>) -> Self {
self.start_time_offset = input;
self
}
/// <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>
pub fn get_start_time_offset(&self) -> &::std::option::Option<i64> {
&self.start_time_offset
}
/// <p>Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.</p>
pub fn destination_configuration(mut self, input: crate::types::DestinationConfiguration) -> Self {
self.destination_configuration = ::std::option::Option::Some(input);
self
}
/// <p>Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.</p>
pub fn set_destination_configuration(mut self, input: ::std::option::Option<crate::types::DestinationConfiguration>) -> Self {
self.destination_configuration = input;
self
}
/// <p>Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.</p>
pub fn get_destination_configuration(&self) -> &::std::option::Option<crate::types::DestinationConfiguration> {
&self.destination_configuration
}
/// <p>The start time for the scheduled query in Unix epoch format. The query will not execute before this time.</p>
pub fn schedule_start_time(mut self, input: i64) -> Self {
self.schedule_start_time = ::std::option::Option::Some(input);
self
}
/// <p>The start time for the scheduled query in Unix epoch format. The query will not execute before this time.</p>
pub fn set_schedule_start_time(mut self, input: ::std::option::Option<i64>) -> Self {
self.schedule_start_time = input;
self
}
/// <p>The start time for the scheduled query in Unix epoch format. The query will not execute before this time.</p>
pub fn get_schedule_start_time(&self) -> &::std::option::Option<i64> {
&self.schedule_start_time
}
/// <p>The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.</p>
pub fn schedule_end_time(mut self, input: i64) -> Self {
self.schedule_end_time = ::std::option::Option::Some(input);
self
}
/// <p>The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.</p>
pub fn set_schedule_end_time(mut self, input: ::std::option::Option<i64>) -> Self {
self.schedule_end_time = input;
self
}
/// <p>The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.</p>
pub fn get_schedule_end_time(&self) -> &::std::option::Option<i64> {
&self.schedule_end_time
}
/// <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>
/// This field is required.
pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.execution_role_arn = ::std::option::Option::Some(input.into());
self
}
/// <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>
pub fn set_execution_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.execution_role_arn = input;
self
}
/// <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>
pub fn get_execution_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.execution_role_arn
}
/// <p>The initial state of the scheduled query. Valid values are <code>ENABLED</code> and <code>DISABLED</code>. Default is <code>ENABLED</code>.</p>
pub fn state(mut self, input: crate::types::ScheduledQueryState) -> Self {
self.state = ::std::option::Option::Some(input);
self
}
/// <p>The initial state of the scheduled query. Valid values are <code>ENABLED</code> and <code>DISABLED</code>. Default is <code>ENABLED</code>.</p>
pub fn set_state(mut self, input: ::std::option::Option<crate::types::ScheduledQueryState>) -> Self {
self.state = input;
self
}
/// <p>The initial state of the scheduled query. Valid values are <code>ENABLED</code> and <code>DISABLED</code>. Default is <code>ENABLED</code>.</p>
pub fn get_state(&self) -> &::std::option::Option<crate::types::ScheduledQueryState> {
&self.state
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Key-value pairs to associate with the scheduled query for resource management and cost allocation.</p>
pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = ::std::option::Option::Some(hash_map);
self
}
/// <p>Key-value pairs to associate with the scheduled query for resource management and cost allocation.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.tags = input;
self
}
/// <p>Key-value pairs to associate with the scheduled query for resource management and cost allocation.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.tags
}
/// Consumes the builder and constructs a [`CreateScheduledQueryInput`](crate::operation::create_scheduled_query::CreateScheduledQueryInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_scheduled_query::CreateScheduledQueryInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::create_scheduled_query::CreateScheduledQueryInput {
name: self.name,
description: self.description,
query_language: self.query_language,
query_string: self.query_string,
log_group_identifiers: self.log_group_identifiers,
schedule_expression: self.schedule_expression,
timezone: self.timezone,
start_time_offset: self.start_time_offset,
destination_configuration: self.destination_configuration,
schedule_start_time: self.schedule_start_time,
schedule_end_time: self.schedule_end_time,
execution_role_arn: self.execution_role_arn,
state: self.state,
tags: self.tags,
})
}
}