Package software.amazon.awscdk.services.cloudwatch

Class CompositeAlarm.Builder

java.lang.Object
software.amazon.awscdk.services.cloudwatch.CompositeAlarm.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CompositeAlarm>
Enclosing class:
CompositeAlarm
@Stability(Stable) public static final class CompositeAlarm.Builder extends Object implements software.amazon.jsii.Builder<CompositeAlarm>
A fluent builder for CompositeAlarm.

  • Method Details

    • create

      @Stability(Stable) public static CompositeAlarm.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of CompositeAlarm.Builder.

    • alarmRule

      @Stability(Stable) public CompositeAlarm.Builder alarmRule(IAlarmRule alarmRule)
      Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.

      Parameters:
      alarmRule - Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. This parameter is required.
      Returns:
      this

    • actionsEnabled

      @Stability(Stable) public CompositeAlarm.Builder actionsEnabled(Boolean actionsEnabled)
      Whether the actions for this alarm are enabled.

      Default: true

      Parameters:
      actionsEnabled - Whether the actions for this alarm are enabled. This parameter is required.
      Returns:
      this

    • actionsSuppressor

      @Stability(Stable) public CompositeAlarm.Builder actionsSuppressor(IAlarm actionsSuppressor)
      Actions will be suppressed if the suppressor alarm is in the ALARM state.

      Default: - alarm will not be suppressed.

      Parameters:
      actionsSuppressor - Actions will be suppressed if the suppressor alarm is in the ALARM state. This parameter is required.
      Returns:
      this

    • actionsSuppressorExtensionPeriod

      @Stability(Stable) public CompositeAlarm.Builder actionsSuppressorExtensionPeriod(Duration actionsSuppressorExtensionPeriod)
      The maximum duration that the composite alarm waits after suppressor alarm goes out of the ALARM state.

      After this time, the composite alarm performs its actions.

      Default: - 1 minute extension period will be set.

      Parameters:
      actionsSuppressorExtensionPeriod - The maximum duration that the composite alarm waits after suppressor alarm goes out of the ALARM state. This parameter is required.
      Returns:
      this

    • actionsSuppressorWaitPeriod

      @Stability(Stable) public CompositeAlarm.Builder actionsSuppressorWaitPeriod(Duration actionsSuppressorWaitPeriod)
      The maximum duration that the composite alarm waits for the suppressor alarm to go into the ALARM state.

      After this time, the composite alarm performs its actions.

      Default: - 1 minute wait period will be set.

      Parameters:
      actionsSuppressorWaitPeriod - The maximum duration that the composite alarm waits for the suppressor alarm to go into the ALARM state. This parameter is required.
      Returns:
      this

    • alarmDescription

      @Stability(Stable) public CompositeAlarm.Builder alarmDescription(String alarmDescription)
      Description for the alarm.

      Default: - No description.

      Parameters:
      alarmDescription - Description for the alarm. This parameter is required.
      Returns:
      this

    • compositeAlarmName

      @Stability(Stable) public CompositeAlarm.Builder compositeAlarmName(String compositeAlarmName)
      Name of the alarm.

      Default: - Automatically generated name.

      Parameters:
      compositeAlarmName - Name of the alarm. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CompositeAlarm build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CompositeAlarm>
      Returns:
      a newly built instance of CompositeAlarm.