Class CompositeAlarmProps.Builder
java.lang.Object
software.amazon.awscdk.services.cloudwatch.CompositeAlarmProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CompositeAlarmProps>
- Enclosing interface:
CompositeAlarmProps
@Stability(Stable)
public static final class CompositeAlarmProps.Builder
extends Object
implements software.amazon.jsii.Builder<CompositeAlarmProps>
A builder for
CompositeAlarmProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactionsEnabled(Boolean actionsEnabled) Sets the value ofCompositeAlarmProps.getActionsEnabled()actionsSuppressor(IAlarm actionsSuppressor) Sets the value ofCompositeAlarmProps.getActionsSuppressor()actionsSuppressorExtensionPeriod(Duration actionsSuppressorExtensionPeriod) Sets the value ofCompositeAlarmProps.getActionsSuppressorExtensionPeriod()actionsSuppressorWaitPeriod(Duration actionsSuppressorWaitPeriod) Sets the value ofCompositeAlarmProps.getActionsSuppressorWaitPeriod()alarmDescription(String alarmDescription) Sets the value ofCompositeAlarmProps.getAlarmDescription()alarmRule(IAlarmRule alarmRule) Sets the value ofCompositeAlarmProps.getAlarmRule()build()Builds the configured instance.compositeAlarmName(String compositeAlarmName) Sets the value ofCompositeAlarmProps.getCompositeAlarmName()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
alarmRule
Sets the value ofCompositeAlarmProps.getAlarmRule()- 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
Sets the value ofCompositeAlarmProps.getActionsEnabled()- Parameters:
actionsEnabled- Whether the actions for this alarm are enabled.- Returns:
this
-
actionsSuppressor
Sets the value ofCompositeAlarmProps.getActionsSuppressor()- Parameters:
actionsSuppressor- Actions will be suppressed if the suppressor alarm is in the ALARM state.- Returns:
this
-
actionsSuppressorExtensionPeriod
@Stability(Stable) public CompositeAlarmProps.Builder actionsSuppressorExtensionPeriod(Duration actionsSuppressorExtensionPeriod) Sets the value ofCompositeAlarmProps.getActionsSuppressorExtensionPeriod()- Parameters:
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.- Returns:
this
-
actionsSuppressorWaitPeriod
@Stability(Stable) public CompositeAlarmProps.Builder actionsSuppressorWaitPeriod(Duration actionsSuppressorWaitPeriod) Sets the value ofCompositeAlarmProps.getActionsSuppressorWaitPeriod()- Parameters:
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.- Returns:
this
-
alarmDescription
Sets the value ofCompositeAlarmProps.getAlarmDescription()- Parameters:
alarmDescription- Description for the alarm.- Returns:
this
-
compositeAlarmName
Sets the value ofCompositeAlarmProps.getCompositeAlarmName()- Parameters:
compositeAlarmName- Name of the alarm.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CompositeAlarmProps>- Returns:
- a new instance of
CompositeAlarmProps - Throws:
NullPointerException- if any required attribute was not provided
-