software.amazon.awscdk.services.cloudwatch

Class CfnCompositeAlarmProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CfnCompositeAlarmProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCompositeAlarmProps>

Enclosing interface:

CfnCompositeAlarmProps

@Stability(value=Stable)
public static final class CfnCompositeAlarmProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCompositeAlarmProps>

A builder for CfnCompositeAlarmProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnCompositeAlarmProps.Builder	actionsEnabled(Boolean actionsEnabled) Sets the value of CfnCompositeAlarmProps.getActionsEnabled()
CfnCompositeAlarmProps.Builder	actionsEnabled(IResolvable actionsEnabled) Sets the value of CfnCompositeAlarmProps.getActionsEnabled()
CfnCompositeAlarmProps.Builder	actionsSuppressor(String actionsSuppressor) Sets the value of CfnCompositeAlarmProps.getActionsSuppressor()
CfnCompositeAlarmProps.Builder	actionsSuppressorExtensionPeriod(Number actionsSuppressorExtensionPeriod) Sets the value of CfnCompositeAlarmProps.getActionsSuppressorExtensionPeriod()
CfnCompositeAlarmProps.Builder	actionsSuppressorWaitPeriod(Number actionsSuppressorWaitPeriod) Sets the value of CfnCompositeAlarmProps.getActionsSuppressorWaitPeriod()
CfnCompositeAlarmProps.Builder	alarmActions(List<String> alarmActions) Sets the value of CfnCompositeAlarmProps.getAlarmActions()
CfnCompositeAlarmProps.Builder	alarmDescription(String alarmDescription) Sets the value of CfnCompositeAlarmProps.getAlarmDescription()
CfnCompositeAlarmProps.Builder	alarmName(String alarmName) Sets the value of CfnCompositeAlarmProps.getAlarmName()
CfnCompositeAlarmProps.Builder	alarmRule(String alarmRule) Sets the value of CfnCompositeAlarmProps.getAlarmRule()
CfnCompositeAlarmProps	build() Builds the configured instance.
CfnCompositeAlarmProps.Builder	insufficientDataActions(List<String> insufficientDataActions) Sets the value of CfnCompositeAlarmProps.getInsufficientDataActions()
CfnCompositeAlarmProps.Builder	okActions(List<String> okActions) Sets the value of CfnCompositeAlarmProps.getOkActions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

alarmRule

@Stability(value=Stable)
public CfnCompositeAlarmProps.Builder alarmRule(String alarmRule)

Sets the value of CfnCompositeAlarmProps.getAlarmRule()

Parameters:

alarmRule - An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. This parameter is required. 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

actionsEnabled

@Stability(value=Stable)
public CfnCompositeAlarmProps.Builder actionsEnabled(Boolean actionsEnabled)

Sets the value of CfnCompositeAlarmProps.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(value=Stable)
public CfnCompositeAlarmProps.Builder actionsEnabled(IResolvable actionsEnabled)

Sets the value of CfnCompositeAlarmProps.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(value=Stable)
public CfnCompositeAlarmProps.Builder actionsSuppressor(String actionsSuppressor)

Sets the value of CfnCompositeAlarmProps.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(value=Stable)
public CfnCompositeAlarmProps.Builder actionsSuppressorExtensionPeriod(Number actionsSuppressorExtensionPeriod)

Sets the value of CfnCompositeAlarmProps.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(value=Stable)
public CfnCompositeAlarmProps.Builder actionsSuppressorWaitPeriod(Number actionsSuppressorWaitPeriod)

Sets the value of CfnCompositeAlarmProps.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(value=Stable)
public CfnCompositeAlarmProps.Builder alarmActions(List<String> alarmActions)

Sets the value of CfnCompositeAlarmProps.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(value=Stable)
public CfnCompositeAlarmProps.Builder alarmDescription(String alarmDescription)

Sets the value of CfnCompositeAlarmProps.getAlarmDescription()

Parameters:

alarmDescription - The description for the composite alarm.

Returns:

this

alarmName

@Stability(value=Stable)
public CfnCompositeAlarmProps.Builder alarmName(String alarmName)

Sets the value of CfnCompositeAlarmProps.getAlarmName()

Parameters:

alarmName - The name for the composite alarm. This name must be unique within your AWS account.

Returns:

this

insufficientDataActions

@Stability(value=Stable)
public CfnCompositeAlarmProps.Builder insufficientDataActions(List<String> insufficientDataActions)

Sets the value of CfnCompositeAlarmProps.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(value=Stable)
public CfnCompositeAlarmProps.Builder okActions(List<String> okActions)

Sets the value of CfnCompositeAlarmProps.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

build

@Stability(value=Stable)
public CfnCompositeAlarmProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCompositeAlarmProps>

Returns:

a new instance of CfnCompositeAlarmProps

Throws:

NullPointerException - if any required attribute was not provided