software.amazon.awscdk.services.cloudwatch

Interface CfnCompositeAlarmProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCompositeAlarmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.229Z")
 @Stability(value=Stable)
public interface CfnCompositeAlarmProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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()
         .alarmName("alarmName")
         .alarmRule("alarmRule")
         // the properties below are optional
         .actionsEnabled(false)
         .actionsSuppressor("actionsSuppressor")
         .actionsSuppressorExtensionPeriod(123)
         .actionsSuppressorWaitPeriod(123)
         .alarmActions(List.of("alarmActions"))
         .alarmDescription("alarmDescription")
         .insufficientDataActions(List.of("insufficientDataActions"))
         .okActions(List.of("okActions"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCompositeAlarmProps.Builder A builder for CfnCompositeAlarmProps
static class	CfnCompositeAlarmProps.Jsii$Proxy An implementation for CfnCompositeAlarmProps

Method Summary

Modifier and Type	Method and Description
static CfnCompositeAlarmProps.Builder	builder()
default Object	getActionsEnabled() Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
default String	getActionsSuppressor() `AWS::CloudWatch::CompositeAlarm.ActionsSuppressor`.
default Number	getActionsSuppressorExtensionPeriod() `AWS::CloudWatch::CompositeAlarm.ActionsSuppressorExtensionPeriod`.
default Number	getActionsSuppressorWaitPeriod() `AWS::CloudWatch::CompositeAlarm.ActionsSuppressorWaitPeriod`.
default List<String>	getAlarmActions() The actions to execute when this alarm transitions to the ALARM state from any other state.
default String	getAlarmDescription() The description for the composite alarm.
String	getAlarmName() The name for the composite alarm.
String	getAlarmRule() An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
default List<String>	getInsufficientDataActions() The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
default List<String>	getOkActions() 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 Detail

getAlarmName

@Stability(value=Stable)
 @NotNull
String getAlarmName()

The name for the composite alarm.

This name must be unique within your AWS account.

getAlarmRule

@Stability(value=Stable)
 @NotNull
String 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

@Stability(value=Stable)
 @Nullable
default Object getActionsEnabled()

Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.

The default is TRUE.

getActionsSuppressor

@Stability(value=Stable)
 @Nullable
default String getActionsSuppressor()

`AWS::CloudWatch::CompositeAlarm.ActionsSuppressor`.

getActionsSuppressorExtensionPeriod

@Stability(value=Stable)
 @Nullable
default Number getActionsSuppressorExtensionPeriod()

`AWS::CloudWatch::CompositeAlarm.ActionsSuppressorExtensionPeriod`.

getActionsSuppressorWaitPeriod

@Stability(value=Stable)
 @Nullable
default Number getActionsSuppressorWaitPeriod()

`AWS::CloudWatch::CompositeAlarm.ActionsSuppressorWaitPeriod`.

getAlarmActions

@Stability(value=Stable)
 @Nullable
default List<String> 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

@Stability(value=Stable)
 @Nullable
default String getAlarmDescription()

The description for the composite alarm.

getInsufficientDataActions

@Stability(value=Stable)
 @Nullable
default List<String> 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

@Stability(value=Stable)
 @Nullable
default List<String> 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

@Stability(value=Stable)
static CfnCompositeAlarmProps.Builder builder()

Returns:

a CfnCompositeAlarmProps.Builder of CfnCompositeAlarmProps