Interface CfnCompositeAlarmProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCompositeAlarmProps.Jsii$Proxy
CfnCompositeAlarm
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cloudwatch.*; CfnCompositeAlarmProps cfnCompositeAlarmProps = CfnCompositeAlarmProps.builder() .alarmRule("alarmRule") // the properties below are optional .actionsEnabled(false) .actionsSuppressor("actionsSuppressor") .actionsSuppressorExtensionPeriod(123) .actionsSuppressorWaitPeriod(123) .alarmActions(List.of("alarmActions")) .alarmDescription("alarmDescription") .alarmName("alarmName") .insufficientDataActions(List.of("insufficientDataActions")) .okActions(List.of("okActions")) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnCompositeAlarmProps
static final class
An implementation forCfnCompositeAlarmProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.default String
Actions will be suppressed if the suppressor alarm is in theALARM
state.default Number
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of theALARM
state.default Number
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into theALARM
state.The actions to execute when this alarm transitions to the ALARM state from any other state.default String
The description for the composite alarm.default String
The name for the composite alarm.An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.The actions to execute when this alarm transitions to the OK state from any other state.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAlarmRule
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.
For more information about
AlarmRule
syntax, see PutCompositeAlarm in the Amazon CloudWatch API Reference . -
getActionsEnabled
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.The default is TRUE.
-
getActionsSuppressor
Actions will be suppressed if the suppressor alarm is in theALARM
state.ActionsSuppressor
can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm. -
getActionsSuppressorExtensionPeriod
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of theALARM
state.After this time, the composite alarm performs its actions.
ExtensionPeriod
is required only whenActionsSuppressor
is specified. -
getActionsSuppressorWaitPeriod
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into theALARM
state.After this time, the composite alarm performs its actions.
WaitPeriod
is required only whenActionsSuppressor
is specified. -
getAlarmActions
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). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .
-
getAlarmDescription
The description for the composite alarm. -
getAlarmName
The name for the composite alarm.This name must be unique within your AWS account.
-
getInsufficientDataActions
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). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .
-
getOkActions
The actions to execute when this alarm transitions to the OK state from any other state.Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .
-
builder
- Returns:
- a
CfnCompositeAlarmProps.Builder
ofCfnCompositeAlarmProps
-