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

Class CfnCompositeAlarmMixinProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • actionsEnabled

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder actionsEnabled(Boolean actionsEnabled)
      Sets the value of CfnCompositeAlarmMixinProps.getActionsEnabled()
      Parameters:
      actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.
      Returns:
      this

    • actionsEnabled

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder actionsEnabled(IResolvable actionsEnabled)
      Sets the value of CfnCompositeAlarmMixinProps.getActionsEnabled()
      Parameters:
      actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.
      Returns:
      this

    • actionsSuppressor

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder actionsSuppressor(String actionsSuppressor)
      Sets the value of CfnCompositeAlarmMixinProps.getActionsSuppressor()
      Parameters:
      actionsSuppressor - 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.
      Returns:
      this

    • actionsSuppressor

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder actionsSuppressor(IAlarmRef actionsSuppressor)
      Sets the value of CfnCompositeAlarmMixinProps.getActionsSuppressor()
      Parameters:
      actionsSuppressor - 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.
      Returns:
      this

    • actionsSuppressor

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder actionsSuppressor(ICompositeAlarmRef actionsSuppressor)
      Sets the value of CfnCompositeAlarmMixinProps.getActionsSuppressor()
      Parameters:
      actionsSuppressor - 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.
      Returns:
      this

    • actionsSuppressorExtensionPeriod

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder actionsSuppressorExtensionPeriod(Number actionsSuppressorExtensionPeriod)
      Sets the value of CfnCompositeAlarmMixinProps.getActionsSuppressorExtensionPeriod()
      Parameters:
      actionsSuppressorExtensionPeriod - 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.

      Returns:
      this

    • actionsSuppressorWaitPeriod

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder actionsSuppressorWaitPeriod(Number actionsSuppressorWaitPeriod)
      Sets the value of CfnCompositeAlarmMixinProps.getActionsSuppressorWaitPeriod()
      Parameters:
      actionsSuppressorWaitPeriod - 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.

      Returns:
      this

    • alarmActions

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder alarmActions(List<? extends Object> alarmActions)
      Sets the value of CfnCompositeAlarmMixinProps.getAlarmActions()
      Parameters:
      alarmActions - 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 .
      Returns:
      this

    • alarmDescription

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder alarmDescription(String alarmDescription)
      Sets the value of CfnCompositeAlarmMixinProps.getAlarmDescription()
      Parameters:
      alarmDescription - The description for the composite alarm.
      Returns:
      this

    • alarmName

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder alarmName(String alarmName)
      Sets the value of CfnCompositeAlarmMixinProps.getAlarmName()
      Parameters:
      alarmName - The name for the composite alarm. This name must be unique within your AWS account.
      Returns:
      this

    • alarmRule

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder alarmRule(String alarmRule)
      Sets the value of CfnCompositeAlarmMixinProps.getAlarmRule()
      Parameters:
      alarmRule - 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 .

      Returns:
      this

    • insufficientDataActions

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder insufficientDataActions(List<String> insufficientDataActions)
      Sets the value of CfnCompositeAlarmMixinProps.getInsufficientDataActions()
      Parameters:
      insufficientDataActions - 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 .
      Returns:
      this

    • okActions

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder okActions(List<? extends Object> okActions)
      Sets the value of CfnCompositeAlarmMixinProps.getOkActions()
      Parameters:
      okActions - 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 .
      Returns:
      this

    • tags

      @Stability(Stable) public CfnCompositeAlarmMixinProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnCompositeAlarmMixinProps.getTags()
      Parameters:
      tags - A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      Returns:
      this

    • build

      @Stability(Stable) public CfnCompositeAlarmMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnCompositeAlarmMixinProps>
      Returns:
      a new instance of CfnCompositeAlarmMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided