Package software.amazon.awscdk.services.cloudwatch

Class CfnCompositeAlarm

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudwatch.CfnCompositeAlarm
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.817Z") @Stability(Stable) public class CfnCompositeAlarm extends CfnResource implements IInspectable
A CloudFormation AWS::CloudWatch::CompositeAlarm.

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.

Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

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.services.cloudwatch.*;
 CfnCompositeAlarm cfnCompositeAlarm = CfnCompositeAlarm.Builder.create(this, "MyCfnCompositeAlarm")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCompositeAlarm

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

    • CfnCompositeAlarm

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

    • CfnCompositeAlarm

      @Stability(Stable) public CfnCompositeAlarm(@NotNull Construct scope, @NotNull String id, @NotNull CfnCompositeAlarmProps props)
      Create a new AWS::CloudWatch::CompositeAlarm.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the composite alarm, such as arn:aws:cloudwatch:us-west-2:123456789012:alarm/CompositeAlarmName .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAlarmRule

      @Stability(Stable) @NotNull public 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 .

    • setAlarmRule

      @Stability(Stable) public void setAlarmRule(@NotNull String value)
      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(Stable) @Nullable public Object getActionsEnabled()
      Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.

      The default is TRUE.

    • setActionsEnabled

      @Stability(Stable) public void setActionsEnabled(@Nullable Boolean value)
      Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.

      The default is TRUE.

    • setActionsEnabled

      @Stability(Stable) public void setActionsEnabled(@Nullable IResolvable value)
      Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.

      The default is TRUE.

    • getActionsSuppressor

      @Stability(Stable) @Nullable public String getActionsSuppressor()
      Actions will be suppressed if the suppressor alarm is in the ALARM state.

      ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

    • setActionsSuppressor

      @Stability(Stable) public void setActionsSuppressor(@Nullable String value)
      Actions will be suppressed if the suppressor alarm is in the ALARM state.

      ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

    • getActionsSuppressorExtensionPeriod

      @Stability(Stable) @Nullable public Number getActionsSuppressorExtensionPeriod()
      The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.

      After this time, the composite alarm performs its actions.

      ExtensionPeriod is required only when ActionsSuppressor is specified.

    • setActionsSuppressorExtensionPeriod

      @Stability(Stable) public void setActionsSuppressorExtensionPeriod(@Nullable Number value)
      The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.

      After this time, the composite alarm performs its actions.

      ExtensionPeriod is required only when ActionsSuppressor is specified.

    • getActionsSuppressorWaitPeriod

      @Stability(Stable) @Nullable public Number getActionsSuppressorWaitPeriod()
      The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.

      After this time, the composite alarm performs its actions.

      WaitPeriod is required only when ActionsSuppressor is specified.

    • setActionsSuppressorWaitPeriod

      @Stability(Stable) public void setActionsSuppressorWaitPeriod(@Nullable Number value)
      The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.

      After this time, the composite alarm performs its actions.

      WaitPeriod is required only when ActionsSuppressor is specified.

    • getAlarmActions

      @Stability(Stable) @Nullable public 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 .

    • setAlarmActions

      @Stability(Stable) public void setAlarmActions(@Nullable List<String> value)
      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(Stable) @Nullable public String getAlarmDescription()
      The description for the composite alarm.

    • setAlarmDescription

      @Stability(Stable) public void setAlarmDescription(@Nullable String value)
      The description for the composite alarm.

    • getAlarmName

      @Stability(Stable) @Nullable public String getAlarmName()
      The name for the composite alarm.

      This name must be unique within your AWS account.

    • setAlarmName

      @Stability(Stable) public void setAlarmName(@Nullable String value)
      The name for the composite alarm.

      This name must be unique within your AWS account.

    • getInsufficientDataActions

      @Stability(Stable) @Nullable public 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 .

    • setInsufficientDataActions

      @Stability(Stable) public void setInsufficientDataActions(@Nullable List<String> value)
      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(Stable) @Nullable public 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 .

    • setOkActions

      @Stability(Stable) public void setOkActions(@Nullable List<String> value)
      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 .