Package software.amazon.awscdk.services.cloudwatch

Interface CompositeAlarmProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CompositeAlarmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:36.854Z")
@Stability(Stable)
public interface CompositeAlarmProps
extends software.amazon.jsii.JsiiSerializable

Properties for creating a Composite Alarm.

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

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

Method Summary

Modifier and Type	Method	Description
static CompositeAlarmProps.Builder	builder()
default Boolean	getActionsEnabled()	Whether the actions for this alarm are enabled.
default String	getAlarmDescription()	Description for the alarm.
IAlarmRule	getAlarmRule()	Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
default String	getCompositeAlarmName()	Name of the alarm.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarmRule

@Stability(Stable)
@NotNull
IAlarmRule getAlarmRule()

Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.

getActionsEnabled

@Stability(Stable)
@Nullable
default Boolean getActionsEnabled()

Whether the actions for this alarm are enabled.

Default: true

getAlarmDescription

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

Description for the alarm.

Default: No description

getCompositeAlarmName

@Stability(Stable)
@Nullable
default String getCompositeAlarmName()

Name of the alarm.

Default: Automatically generated name

builder

@Stability(Stable)
static CompositeAlarmProps.Builder builder()

Returns:

a CompositeAlarmProps.Builder of CompositeAlarmProps