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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
// 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 PutLogAlarmInput {
/// <p>The name for the alarm. This name must be unique within the Amazon Web Services account and Region.</p>
pub alarm_name: ::std::option::Option<::std::string::String>,
/// <p>The description for the alarm.</p>
pub alarm_description: ::std::option::Option<::std::string::String>,
/// <p>The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.</p>
pub scheduled_query_configuration: ::std::option::Option<crate::types::ScheduledQueryConfiguration>,
/// <p>The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.</p>
pub action_log_line_count: ::std::option::Option<i32>,
/// <p>The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when <code>ActionLogLineCount</code> is greater than 0.</p>
pub action_log_line_role_arn: ::std::option::Option<::std::string::String>,
/// <p>Indicates whether actions should be executed during any changes to the alarm state. The default is <code>true</code>.</p>
pub actions_enabled: ::std::option::Option<bool>,
/// <p>The actions to execute when this alarm transitions to the <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
pub ok_actions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
/// <p><b>Systems Manager actions:</b></p>
/// <p><code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i> </code></p>
pub alarm_actions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
pub insufficient_data_actions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.</p>
pub query_results_to_evaluate: ::std::option::Option<i32>,
/// <p>The number of query results, out of the most recent <code>QueryResultsToEvaluate</code> results, that must breach the threshold to trigger the alarm to transition to <code>ALARM</code> (the M in M-of-N evaluation). Must be less than or equal to <code>QueryResultsToEvaluate</code>.</p>
pub query_results_to_alarm: ::std::option::Option<i32>,
/// <p>The value to compare with the aggregated query result.</p>
pub threshold: ::std::option::Option<f64>,
/// <p>The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are <code>GreaterThanThreshold</code>, <code>GreaterThanOrEqualToThreshold</code>, <code>LessThanThreshold</code>, and <code>LessThanOrEqualToThreshold</code>.</p>
pub comparison_operator: ::std::option::Option<crate::types::ComparisonOperator>,
/// <p>Sets how this alarm is to handle missing data points. Valid values are <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and <code>missing</code>. If this parameter is omitted, the default behavior of <code>missing</code> is used.</p>
pub treat_missing_data: ::std::option::Option<::std::string::String>,
/// <p>A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl PutLogAlarmInput {
/// <p>The name for the alarm. This name must be unique within the Amazon Web Services account and Region.</p>
pub fn alarm_name(&self) -> ::std::option::Option<&str> {
self.alarm_name.as_deref()
}
/// <p>The description for the alarm.</p>
pub fn alarm_description(&self) -> ::std::option::Option<&str> {
self.alarm_description.as_deref()
}
/// <p>The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.</p>
pub fn scheduled_query_configuration(&self) -> ::std::option::Option<&crate::types::ScheduledQueryConfiguration> {
self.scheduled_query_configuration.as_ref()
}
/// <p>The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.</p>
pub fn action_log_line_count(&self) -> ::std::option::Option<i32> {
self.action_log_line_count
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when <code>ActionLogLineCount</code> is greater than 0.</p>
pub fn action_log_line_role_arn(&self) -> ::std::option::Option<&str> {
self.action_log_line_role_arn.as_deref()
}
/// <p>Indicates whether actions should be executed during any changes to the alarm state. The default is <code>true</code>.</p>
pub fn actions_enabled(&self) -> ::std::option::Option<bool> {
self.actions_enabled
}
/// <p>The actions to execute when this alarm transitions to the <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.ok_actions.is_none()`.
pub fn ok_actions(&self) -> &[::std::string::String] {
self.ok_actions.as_deref().unwrap_or_default()
}
/// <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
/// <p><b>Systems Manager actions:</b></p>
/// <p><code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i> </code></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 `.alarm_actions.is_none()`.
pub fn alarm_actions(&self) -> &[::std::string::String] {
self.alarm_actions.as_deref().unwrap_or_default()
}
/// <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.insufficient_data_actions.is_none()`.
pub fn insufficient_data_actions(&self) -> &[::std::string::String] {
self.insufficient_data_actions.as_deref().unwrap_or_default()
}
/// <p>The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.</p>
pub fn query_results_to_evaluate(&self) -> ::std::option::Option<i32> {
self.query_results_to_evaluate
}
/// <p>The number of query results, out of the most recent <code>QueryResultsToEvaluate</code> results, that must breach the threshold to trigger the alarm to transition to <code>ALARM</code> (the M in M-of-N evaluation). Must be less than or equal to <code>QueryResultsToEvaluate</code>.</p>
pub fn query_results_to_alarm(&self) -> ::std::option::Option<i32> {
self.query_results_to_alarm
}
/// <p>The value to compare with the aggregated query result.</p>
pub fn threshold(&self) -> ::std::option::Option<f64> {
self.threshold
}
/// <p>The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are <code>GreaterThanThreshold</code>, <code>GreaterThanOrEqualToThreshold</code>, <code>LessThanThreshold</code>, and <code>LessThanOrEqualToThreshold</code>.</p>
pub fn comparison_operator(&self) -> ::std::option::Option<&crate::types::ComparisonOperator> {
self.comparison_operator.as_ref()
}
/// <p>Sets how this alarm is to handle missing data points. Valid values are <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and <code>missing</code>. If this parameter is omitted, the default behavior of <code>missing</code> is used.</p>
pub fn treat_missing_data(&self) -> ::std::option::Option<&str> {
self.treat_missing_data.as_deref()
}
/// <p>A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.</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 `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
}
impl PutLogAlarmInput {
/// Creates a new builder-style object to manufacture [`PutLogAlarmInput`](crate::operation::put_log_alarm::PutLogAlarmInput).
pub fn builder() -> crate::operation::put_log_alarm::builders::PutLogAlarmInputBuilder {
crate::operation::put_log_alarm::builders::PutLogAlarmInputBuilder::default()
}
}
/// A builder for [`PutLogAlarmInput`](crate::operation::put_log_alarm::PutLogAlarmInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct PutLogAlarmInputBuilder {
pub(crate) alarm_name: ::std::option::Option<::std::string::String>,
pub(crate) alarm_description: ::std::option::Option<::std::string::String>,
pub(crate) scheduled_query_configuration: ::std::option::Option<crate::types::ScheduledQueryConfiguration>,
pub(crate) action_log_line_count: ::std::option::Option<i32>,
pub(crate) action_log_line_role_arn: ::std::option::Option<::std::string::String>,
pub(crate) actions_enabled: ::std::option::Option<bool>,
pub(crate) ok_actions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) alarm_actions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) insufficient_data_actions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) query_results_to_evaluate: ::std::option::Option<i32>,
pub(crate) query_results_to_alarm: ::std::option::Option<i32>,
pub(crate) threshold: ::std::option::Option<f64>,
pub(crate) comparison_operator: ::std::option::Option<crate::types::ComparisonOperator>,
pub(crate) treat_missing_data: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl PutLogAlarmInputBuilder {
/// <p>The name for the alarm. This name must be unique within the Amazon Web Services account and Region.</p>
/// This field is required.
pub fn alarm_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.alarm_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name for the alarm. This name must be unique within the Amazon Web Services account and Region.</p>
pub fn set_alarm_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.alarm_name = input;
self
}
/// <p>The name for the alarm. This name must be unique within the Amazon Web Services account and Region.</p>
pub fn get_alarm_name(&self) -> &::std::option::Option<::std::string::String> {
&self.alarm_name
}
/// <p>The description for the alarm.</p>
pub fn alarm_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.alarm_description = ::std::option::Option::Some(input.into());
self
}
/// <p>The description for the alarm.</p>
pub fn set_alarm_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.alarm_description = input;
self
}
/// <p>The description for the alarm.</p>
pub fn get_alarm_description(&self) -> &::std::option::Option<::std::string::String> {
&self.alarm_description
}
/// <p>The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.</p>
/// This field is required.
pub fn scheduled_query_configuration(mut self, input: crate::types::ScheduledQueryConfiguration) -> Self {
self.scheduled_query_configuration = ::std::option::Option::Some(input);
self
}
/// <p>The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.</p>
pub fn set_scheduled_query_configuration(mut self, input: ::std::option::Option<crate::types::ScheduledQueryConfiguration>) -> Self {
self.scheduled_query_configuration = input;
self
}
/// <p>The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.</p>
pub fn get_scheduled_query_configuration(&self) -> &::std::option::Option<crate::types::ScheduledQueryConfiguration> {
&self.scheduled_query_configuration
}
/// <p>The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.</p>
pub fn action_log_line_count(mut self, input: i32) -> Self {
self.action_log_line_count = ::std::option::Option::Some(input);
self
}
/// <p>The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.</p>
pub fn set_action_log_line_count(mut self, input: ::std::option::Option<i32>) -> Self {
self.action_log_line_count = input;
self
}
/// <p>The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.</p>
pub fn get_action_log_line_count(&self) -> &::std::option::Option<i32> {
&self.action_log_line_count
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when <code>ActionLogLineCount</code> is greater than 0.</p>
pub fn action_log_line_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.action_log_line_role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when <code>ActionLogLineCount</code> is greater than 0.</p>
pub fn set_action_log_line_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.action_log_line_role_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when <code>ActionLogLineCount</code> is greater than 0.</p>
pub fn get_action_log_line_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.action_log_line_role_arn
}
/// <p>Indicates whether actions should be executed during any changes to the alarm state. The default is <code>true</code>.</p>
pub fn actions_enabled(mut self, input: bool) -> Self {
self.actions_enabled = ::std::option::Option::Some(input);
self
}
/// <p>Indicates whether actions should be executed during any changes to the alarm state. The default is <code>true</code>.</p>
pub fn set_actions_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.actions_enabled = input;
self
}
/// <p>Indicates whether actions should be executed during any changes to the alarm state. The default is <code>true</code>.</p>
pub fn get_actions_enabled(&self) -> &::std::option::Option<bool> {
&self.actions_enabled
}
/// Appends an item to `ok_actions`.
///
/// To override the contents of this collection use [`set_ok_actions`](Self::set_ok_actions).
///
/// <p>The actions to execute when this alarm transitions to the <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
pub fn ok_actions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.ok_actions.unwrap_or_default();
v.push(input.into());
self.ok_actions = ::std::option::Option::Some(v);
self
}
/// <p>The actions to execute when this alarm transitions to the <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
pub fn set_ok_actions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.ok_actions = input;
self
}
/// <p>The actions to execute when this alarm transitions to the <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
pub fn get_ok_actions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.ok_actions
}
/// Appends an item to `alarm_actions`.
///
/// To override the contents of this collection use [`set_alarm_actions`](Self::set_alarm_actions).
///
/// <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
/// <p><b>Systems Manager actions:</b></p>
/// <p><code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i> </code></p>
pub fn alarm_actions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.alarm_actions.unwrap_or_default();
v.push(input.into());
self.alarm_actions = ::std::option::Option::Some(v);
self
}
/// <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
/// <p><b>Systems Manager actions:</b></p>
/// <p><code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i> </code></p>
pub fn set_alarm_actions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.alarm_actions = input;
self
}
/// <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
/// <p><b>Systems Manager actions:</b></p>
/// <p><code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i> </code></p>
pub fn get_alarm_actions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.alarm_actions
}
/// Appends an item to `insufficient_data_actions`.
///
/// To override the contents of this collection use [`set_insufficient_data_actions`](Self::set_insufficient_data_actions).
///
/// <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
pub fn insufficient_data_actions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.insufficient_data_actions.unwrap_or_default();
v.push(input.into());
self.insufficient_data_actions = ::std::option::Option::Some(v);
self
}
/// <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
pub fn set_insufficient_data_actions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.insufficient_data_actions = input;
self
}
/// <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
/// <p>Valid Values:</p>
/// <p><b>Amazon SNS actions:</b></p>
/// <p><code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code></p>
/// <p><b>Lambda actions:</b></p>
/// <ul>
/// <li>
/// <p>Invoke the latest version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i> </code></p></li>
/// <li>
/// <p>Invoke a specific version of a Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i> </code></p></li>
/// <li>
/// <p>Invoke a function by using an alias Lambda function: <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i> </code></p></li>
/// </ul>
pub fn get_insufficient_data_actions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.insufficient_data_actions
}
/// <p>The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.</p>
/// This field is required.
pub fn query_results_to_evaluate(mut self, input: i32) -> Self {
self.query_results_to_evaluate = ::std::option::Option::Some(input);
self
}
/// <p>The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.</p>
pub fn set_query_results_to_evaluate(mut self, input: ::std::option::Option<i32>) -> Self {
self.query_results_to_evaluate = input;
self
}
/// <p>The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.</p>
pub fn get_query_results_to_evaluate(&self) -> &::std::option::Option<i32> {
&self.query_results_to_evaluate
}
/// <p>The number of query results, out of the most recent <code>QueryResultsToEvaluate</code> results, that must breach the threshold to trigger the alarm to transition to <code>ALARM</code> (the M in M-of-N evaluation). Must be less than or equal to <code>QueryResultsToEvaluate</code>.</p>
/// This field is required.
pub fn query_results_to_alarm(mut self, input: i32) -> Self {
self.query_results_to_alarm = ::std::option::Option::Some(input);
self
}
/// <p>The number of query results, out of the most recent <code>QueryResultsToEvaluate</code> results, that must breach the threshold to trigger the alarm to transition to <code>ALARM</code> (the M in M-of-N evaluation). Must be less than or equal to <code>QueryResultsToEvaluate</code>.</p>
pub fn set_query_results_to_alarm(mut self, input: ::std::option::Option<i32>) -> Self {
self.query_results_to_alarm = input;
self
}
/// <p>The number of query results, out of the most recent <code>QueryResultsToEvaluate</code> results, that must breach the threshold to trigger the alarm to transition to <code>ALARM</code> (the M in M-of-N evaluation). Must be less than or equal to <code>QueryResultsToEvaluate</code>.</p>
pub fn get_query_results_to_alarm(&self) -> &::std::option::Option<i32> {
&self.query_results_to_alarm
}
/// <p>The value to compare with the aggregated query result.</p>
/// This field is required.
pub fn threshold(mut self, input: f64) -> Self {
self.threshold = ::std::option::Option::Some(input);
self
}
/// <p>The value to compare with the aggregated query result.</p>
pub fn set_threshold(mut self, input: ::std::option::Option<f64>) -> Self {
self.threshold = input;
self
}
/// <p>The value to compare with the aggregated query result.</p>
pub fn get_threshold(&self) -> &::std::option::Option<f64> {
&self.threshold
}
/// <p>The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are <code>GreaterThanThreshold</code>, <code>GreaterThanOrEqualToThreshold</code>, <code>LessThanThreshold</code>, and <code>LessThanOrEqualToThreshold</code>.</p>
/// This field is required.
pub fn comparison_operator(mut self, input: crate::types::ComparisonOperator) -> Self {
self.comparison_operator = ::std::option::Option::Some(input);
self
}
/// <p>The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are <code>GreaterThanThreshold</code>, <code>GreaterThanOrEqualToThreshold</code>, <code>LessThanThreshold</code>, and <code>LessThanOrEqualToThreshold</code>.</p>
pub fn set_comparison_operator(mut self, input: ::std::option::Option<crate::types::ComparisonOperator>) -> Self {
self.comparison_operator = input;
self
}
/// <p>The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are <code>GreaterThanThreshold</code>, <code>GreaterThanOrEqualToThreshold</code>, <code>LessThanThreshold</code>, and <code>LessThanOrEqualToThreshold</code>.</p>
pub fn get_comparison_operator(&self) -> &::std::option::Option<crate::types::ComparisonOperator> {
&self.comparison_operator
}
/// <p>Sets how this alarm is to handle missing data points. Valid values are <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and <code>missing</code>. If this parameter is omitted, the default behavior of <code>missing</code> is used.</p>
pub fn treat_missing_data(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.treat_missing_data = ::std::option::Option::Some(input.into());
self
}
/// <p>Sets how this alarm is to handle missing data points. Valid values are <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and <code>missing</code>. If this parameter is omitted, the default behavior of <code>missing</code> is used.</p>
pub fn set_treat_missing_data(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.treat_missing_data = input;
self
}
/// <p>Sets how this alarm is to handle missing data points. Valid values are <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and <code>missing</code>. If this parameter is omitted, the default behavior of <code>missing</code> is used.</p>
pub fn get_treat_missing_data(&self) -> &::std::option::Option<::std::string::String> {
&self.treat_missing_data
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// Consumes the builder and constructs a [`PutLogAlarmInput`](crate::operation::put_log_alarm::PutLogAlarmInput).
pub fn build(self) -> ::std::result::Result<crate::operation::put_log_alarm::PutLogAlarmInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::put_log_alarm::PutLogAlarmInput {
alarm_name: self.alarm_name,
alarm_description: self.alarm_description,
scheduled_query_configuration: self.scheduled_query_configuration,
action_log_line_count: self.action_log_line_count,
action_log_line_role_arn: self.action_log_line_role_arn,
actions_enabled: self.actions_enabled,
ok_actions: self.ok_actions,
alarm_actions: self.alarm_actions,
insufficient_data_actions: self.insufficient_data_actions,
query_results_to_evaluate: self.query_results_to_evaluate,
query_results_to_alarm: self.query_results_to_alarm,
threshold: self.threshold,
comparison_operator: self.comparison_operator,
treat_missing_data: self.treat_missing_data,
tags: self.tags,
})
}
}