Struct rusoto_cloudwatch::PutCompositeAlarmInput
source · [−]pub struct PutCompositeAlarmInput {
pub actions_enabled: Option<bool>,
pub alarm_actions: Option<Vec<String>>,
pub alarm_description: Option<String>,
pub alarm_name: String,
pub alarm_rule: String,
pub insufficient_data_actions: Option<Vec<String>>,
pub ok_actions: Option<Vec<String>>,
pub tags: Option<Vec<Tag>>,
}
Fields
actions_enabled: Option<bool>
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE
.
alarm_actions: Option<Vec<String>>
The actions to execute when this alarm transitions to the ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
| arn:aws:ssm:region:account-id:opsitem:severity
alarm_description: Option<String>
The description for the composite alarm.
alarm_name: String
The name for the composite alarm. This name must be unique within the Region.
alarm_rule: String
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.
You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
Functions can include the following:
-
ALARM("alarm-name or alarm-ARN")
is TRUE if the named alarm is in ALARM state. -
OK("alarm-name or alarm-ARN")
is TRUE if the named alarm is in OK state. -
INSUFFICIENT_DATA("alarm-name or alarm-ARN")
is TRUE if the named alarm is in INSUFFICIENT_DATA state. -
TRUE
always evaluates to TRUE. -
FALSE
always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule
structure, and for testing your alarm actions.
Alarm names specified in AlarmRule
can be surrounded with double-quotes ("), but do not have to be.
The following are some examples of AlarmRule
:
-
ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)
specifies that the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state. -
ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)
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. -
(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)
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.
The AlarmRule
can specify as many as 100 "children" alarms. The AlarmRule
expression can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and parentheses.
insufficient_data_actions: Option<Vec<String>>
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
ok_actions: Option<Vec<String>>
The actions to execute when this alarm transitions to an OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
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.
Trait Implementations
sourceimpl Clone for PutCompositeAlarmInput
impl Clone for PutCompositeAlarmInput
sourcefn clone(&self) -> PutCompositeAlarmInput
fn clone(&self) -> PutCompositeAlarmInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PutCompositeAlarmInput
impl Debug for PutCompositeAlarmInput
sourceimpl Default for PutCompositeAlarmInput
impl Default for PutCompositeAlarmInput
sourcefn default() -> PutCompositeAlarmInput
fn default() -> PutCompositeAlarmInput
Returns the “default value” for a type. Read more
sourceimpl PartialEq<PutCompositeAlarmInput> for PutCompositeAlarmInput
impl PartialEq<PutCompositeAlarmInput> for PutCompositeAlarmInput
sourcefn eq(&self, other: &PutCompositeAlarmInput) -> bool
fn eq(&self, other: &PutCompositeAlarmInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PutCompositeAlarmInput) -> bool
fn ne(&self, other: &PutCompositeAlarmInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for PutCompositeAlarmInput
Auto Trait Implementations
impl RefUnwindSafe for PutCompositeAlarmInput
impl Send for PutCompositeAlarmInput
impl Sync for PutCompositeAlarmInput
impl Unpin for PutCompositeAlarmInput
impl UnwindSafe for PutCompositeAlarmInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more