software.amazon.awscdk.services.cloudwatch

Class AlarmRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudwatch.AlarmRule

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.203Z")
 @Stability(value=Stable)
public class AlarmRule
extends software.amazon.jsii.JsiiObject

Class with static functions to build AlarmRule for Composite Alarms.

Example:

 Alarm alarm1;
 Alarm alarm2;
 Alarm alarm3;
 Alarm alarm4;
 IAlarmRule alarmRule = AlarmRule.anyOf(AlarmRule.allOf(AlarmRule.anyOf(alarm1, AlarmRule.fromAlarm(alarm2, AlarmState.OK), alarm3), AlarmRule.not(AlarmRule.fromAlarm(alarm4, AlarmState.INSUFFICIENT_DATA))), AlarmRule.fromBoolean(false));
 CompositeAlarm.Builder.create(this, "MyAwesomeCompositeAlarm")
         .alarmRule(alarmRule)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	AlarmRule()
protected	AlarmRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AlarmRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IAlarmRule	allOf(IAlarmRule... operands) function to join all provided AlarmRules with AND operator.
static IAlarmRule	anyOf(IAlarmRule... operands) function to join all provided AlarmRules with OR operator.
static IAlarmRule	fromAlarm(IAlarm alarm, AlarmState alarmState) function to build Rule Expression for given IAlarm and AlarmState.
static IAlarmRule	fromBoolean(Boolean value) function to build TRUE/FALSE intent for Rule Expression.
static IAlarmRule	fromString(String alarmRule) function to build Rule Expression for given Alarm Rule string.
static IAlarmRule	not(IAlarmRule operand) function to wrap provided AlarmRule in NOT operator.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AlarmRule

protected AlarmRule(software.amazon.jsii.JsiiObjectRef objRef)

AlarmRule

protected AlarmRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AlarmRule

@Stability(value=Stable)
public AlarmRule()

Method Detail

allOf

@Stability(value=Stable)
 @NotNull
public static IAlarmRule allOf(@NotNull
                                                                  IAlarmRule... operands)

function to join all provided AlarmRules with AND operator.

Parameters:

operands - IAlarmRules to be joined with AND operator. This parameter is required.

anyOf

@Stability(value=Stable)
 @NotNull
public static IAlarmRule anyOf(@NotNull
                                                                  IAlarmRule... operands)

function to join all provided AlarmRules with OR operator.

Parameters:

operands - IAlarmRules to be joined with OR operator. This parameter is required.

fromAlarm

@Stability(value=Stable)
 @NotNull
public static IAlarmRule fromAlarm(@NotNull
                                                                      IAlarm alarm,
                                                                      @NotNull
                                                                      AlarmState alarmState)

function to build Rule Expression for given IAlarm and AlarmState.

Parameters:

alarm - IAlarm to be used in Rule Expression. This parameter is required.

alarmState - AlarmState to be used in Rule Expression. This parameter is required.

fromBoolean

@Stability(value=Stable)
 @NotNull
public static IAlarmRule fromBoolean(@NotNull
                                                                        Boolean value)

function to build TRUE/FALSE intent for Rule Expression.

Parameters:

value - boolean value to be used in rule expression. This parameter is required.

fromString

@Stability(value=Stable)
 @NotNull
public static IAlarmRule fromString(@NotNull
                                                                       String alarmRule)

function to build Rule Expression for given Alarm Rule string.

Parameters:

alarmRule - string to be used in Rule Expression. This parameter is required.

not

@Stability(value=Stable)
 @NotNull
public static IAlarmRule not(@NotNull
                                                                IAlarmRule operand)

function to wrap provided AlarmRule in NOT operator.

Parameters:

operand - IAlarmRule to be wrapped in NOT operator. This parameter is required.