Package software.amazon.awscdk.cfnpropertymixins.services.cloudwatch

Class CfnCompositeAlarmPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.cloudwatch.CfnCompositeAlarmPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:57.201Z") @Stability(Stable) public class CfnCompositeAlarmPropsMixin extends Mixin implements software.constructs.IMixin
The AWS::CloudWatch::CompositeAlarm type creates or updates a composite alarm.

When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudwatch.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnCompositeAlarmPropsMixin cfnCompositeAlarmPropsMixin = CfnCompositeAlarmPropsMixin.Builder.create(CfnCompositeAlarmMixinProps.builder()
         .actionsEnabled(false)
         .actionsSuppressor("actionsSuppressor")
         .actionsSuppressorExtensionPeriod(123)
         .actionsSuppressorWaitPeriod(123)
         .alarmActions(List.of("alarmActions"))
         .alarmDescription("alarmDescription")
         .alarmName("alarmName")
         .alarmRule("alarmRule")
         .insufficientDataActions(List.of("insufficientDataActions"))
         .okActions(List.of("okActions"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnCompositeAlarmPropsMixin

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

    • CfnCompositeAlarmPropsMixin

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

    • CfnCompositeAlarmPropsMixin

      @Stability(Stable) public CfnCompositeAlarmPropsMixin(@NotNull CfnCompositeAlarmMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::CloudWatch::CompositeAlarm.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnCompositeAlarmPropsMixin

      @Stability(Stable) public CfnCompositeAlarmPropsMixin(@NotNull CfnCompositeAlarmMixinProps props)
      Create a mixin to apply properties to AWS::CloudWatch::CompositeAlarm.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnCompositeAlarmMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()