aws_sdk_cloudwatch/client/

put_composite_alarm.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`PutCompositeAlarm`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`actions_enabled(bool)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::actions_enabled) / [`set_actions_enabled(Option<bool>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_actions_enabled):<br>required: **false**<br><p>Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is <code>TRUE</code>.</p><br>
    ///   - [`alarm_actions(impl Into<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::alarm_actions) / [`set_alarm_actions(Option<Vec::<String>>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_alarm_actions):<br>required: **false**<br><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> <p><b>Start a Amazon Q Developer operational investigation</b></p> <p><code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>investigation-group-id</i> </code></p><br>
    ///   - [`alarm_description(impl Into<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::alarm_description) / [`set_alarm_description(Option<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_alarm_description):<br>required: **false**<br><p>The description for the composite alarm.</p><br>
    ///   - [`alarm_name(impl Into<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::alarm_name) / [`set_alarm_name(Option<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_alarm_name):<br>required: **true**<br><p>The name for the composite alarm. This name must be unique within the Region.</p><br>
    ///   - [`alarm_rule(impl Into<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::alarm_rule) / [`set_alarm_rule(Option<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_alarm_rule):<br>required: **true**<br><p>An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.</p> <p>You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.</p> <p>Functions can include the following:</p> <ul>  <li>   <p><code>ALARM("<i>alarm-name</i> or <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in ALARM state.</p></li>  <li>   <p><code>OK("<i>alarm-name</i> or <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in OK state.</p></li>  <li>   <p><code>INSUFFICIENT_DATA("<i>alarm-name</i> or <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in INSUFFICIENT_DATA state.</p></li>  <li>   <p><code>TRUE</code> always evaluates to TRUE.</p></li>  <li>   <p><code>FALSE</code> always evaluates to FALSE.</p></li> </ul> <p>TRUE and FALSE are useful for testing a complex <code>AlarmRule</code> structure, and for testing your alarm actions.</p> <p>Alarm names specified in <code>AlarmRule</code> can be surrounded with double-quotes ("), but do not have to be.</p> <p>The following are some examples of <code>AlarmRule</code>:</p> <ul>  <li>   <p><code>ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)</code> specifies that the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.</p></li>  <li>   <p><code>ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)</code> specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in ALARM state. This example reduces alarm noise during a known deployment window.</p></li>  <li>   <p><code>(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)</code> goes into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. This provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an alarm action on high CPU or disk usage if a known network problem is also occurring.</p></li> </ul> <p>The <code>AlarmRule</code> can specify as many as 100 "children" alarms. The <code>AlarmRule</code> expression can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and parentheses.</p><br>
    ///   - [`insufficient_data_actions(impl Into<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::insufficient_data_actions) / [`set_insufficient_data_actions(Option<Vec::<String>>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_insufficient_data_actions):<br>required: **false**<br><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><br>
    ///   - [`ok_actions(impl Into<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::ok_actions) / [`set_ok_actions(Option<Vec::<String>>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_ok_actions):<br>required: **false**<br><p>The actions to execute when this alarm transitions to an <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><br>
    ///   - [`tags(Tag)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_tags):<br>required: **false**<br><p>A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the <code>cloudwatch:TagResource</code> permission.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.</p> <p>If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p><br>
    ///   - [`actions_suppressor(impl Into<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::actions_suppressor) / [`set_actions_suppressor(Option<String>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_actions_suppressor):<br>required: **false**<br><p>Actions will be suppressed if the suppressor alarm is in the <code>ALARM</code> state. <code>ActionsSuppressor</code> can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.</p><br>
    ///   - [`actions_suppressor_wait_period(i32)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::actions_suppressor_wait_period) / [`set_actions_suppressor_wait_period(Option<i32>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_actions_suppressor_wait_period):<br>required: **false**<br><p>The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the <code>ALARM</code> state. After this time, the composite alarm performs its actions.</p><important>  <p><code>WaitPeriod</code> is required only when <code>ActionsSuppressor</code> is specified.</p> </important><br>
    ///   - [`actions_suppressor_extension_period(i32)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::actions_suppressor_extension_period) / [`set_actions_suppressor_extension_period(Option<i32>)`](crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::set_actions_suppressor_extension_period):<br>required: **false**<br><p>The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the <code>ALARM</code> state. After this time, the composite alarm performs its actions.</p><important>  <p><code>ExtensionPeriod</code> is required only when <code>ActionsSuppressor</code> is specified.</p> </important><br>
    /// - On success, responds with [`PutCompositeAlarmOutput`](crate::operation::put_composite_alarm::PutCompositeAlarmOutput)
    /// - On failure, responds with [`SdkError<PutCompositeAlarmError>`](crate::operation::put_composite_alarm::PutCompositeAlarmError)
    pub fn put_composite_alarm(&self) -> crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder {
        crate::operation::put_composite_alarm::builders::PutCompositeAlarmFluentBuilder::new(self.handle.clone())
    }
}