software.amazon.awscdk.services.cloudwatch

Class CfnCompositeAlarm.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CfnCompositeAlarm.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCompositeAlarm>

Enclosing class:

CfnCompositeAlarm

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

A fluent builder for CfnCompositeAlarm.

Method Summary

Modifier and Type	Method and Description
CfnCompositeAlarm.Builder	actionsEnabled(Boolean actionsEnabled) Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
CfnCompositeAlarm.Builder	actionsEnabled(IResolvable actionsEnabled) Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
CfnCompositeAlarm.Builder	actionsSuppressor(String actionsSuppressor) `AWS::CloudWatch::CompositeAlarm.ActionsSuppressor`.
CfnCompositeAlarm.Builder	actionsSuppressorExtensionPeriod(Number actionsSuppressorExtensionPeriod) `AWS::CloudWatch::CompositeAlarm.ActionsSuppressorExtensionPeriod`.
CfnCompositeAlarm.Builder	actionsSuppressorWaitPeriod(Number actionsSuppressorWaitPeriod) `AWS::CloudWatch::CompositeAlarm.ActionsSuppressorWaitPeriod`.
CfnCompositeAlarm.Builder	alarmActions(List<String> alarmActions) The actions to execute when this alarm transitions to the ALARM state from any other state.
CfnCompositeAlarm.Builder	alarmDescription(String alarmDescription) The description for the composite alarm.
CfnCompositeAlarm.Builder	alarmName(String alarmName) The name for the composite alarm.
CfnCompositeAlarm.Builder	alarmRule(String alarmRule) An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
CfnCompositeAlarm	build()
static CfnCompositeAlarm.Builder	create(software.constructs.Construct scope, String id)
CfnCompositeAlarm.Builder	insufficientDataActions(List<String> insufficientDataActions) The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
CfnCompositeAlarm.Builder	okActions(List<String> okActions) The actions to execute when this alarm transitions to the OK state from any other state.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnCompositeAlarm.Builder create(software.constructs.Construct scope,
                                                                        String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnCompositeAlarm.Builder.

alarmName

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

The name for the composite alarm.

This name must be unique within your AWS account.

Parameters:

alarmName - The name for the composite alarm. This parameter is required.

Returns:

this

alarmRule

@Stability(value=Stable)
public CfnCompositeAlarm.Builder alarmRule(String 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 .

Parameters:

alarmRule - An 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(value=Stable)
public CfnCompositeAlarm.Builder actionsEnabled(Boolean actionsEnabled)

Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.

The default is TRUE.

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. This parameter is required.

Returns:

this

actionsEnabled

@Stability(value=Stable)
public CfnCompositeAlarm.Builder actionsEnabled(IResolvable actionsEnabled)

Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.

The default is TRUE.

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. This parameter is required.

Returns:

this

actionsSuppressor

@Stability(value=Stable)
public CfnCompositeAlarm.Builder actionsSuppressor(String actionsSuppressor)

`AWS::CloudWatch::CompositeAlarm.ActionsSuppressor`.

Parameters:

actionsSuppressor - `AWS::CloudWatch::CompositeAlarm.ActionsSuppressor`. This parameter is required.

Returns:

this

actionsSuppressorExtensionPeriod

@Stability(value=Stable)
public CfnCompositeAlarm.Builder actionsSuppressorExtensionPeriod(Number actionsSuppressorExtensionPeriod)

`AWS::CloudWatch::CompositeAlarm.ActionsSuppressorExtensionPeriod`.

Parameters:

actionsSuppressorExtensionPeriod - `AWS::CloudWatch::CompositeAlarm.ActionsSuppressorExtensionPeriod`. This parameter is required.

Returns:

this

actionsSuppressorWaitPeriod

@Stability(value=Stable)
public CfnCompositeAlarm.Builder actionsSuppressorWaitPeriod(Number actionsSuppressorWaitPeriod)

`AWS::CloudWatch::CompositeAlarm.ActionsSuppressorWaitPeriod`.

Parameters:

actionsSuppressorWaitPeriod - `AWS::CloudWatch::CompositeAlarm.ActionsSuppressorWaitPeriod`. This parameter is required.

Returns:

this

alarmActions

@Stability(value=Stable)
public CfnCompositeAlarm.Builder alarmActions(List<String> 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 .

Parameters:

alarmActions - The actions to execute when this alarm transitions to the ALARM state from any other state. This parameter is required.

Returns:

this

alarmDescription

@Stability(value=Stable)
public CfnCompositeAlarm.Builder alarmDescription(String alarmDescription)

The description for the composite alarm.

Parameters:

alarmDescription - The description for the composite alarm. This parameter is required.

Returns:

this

insufficientDataActions

@Stability(value=Stable)
public CfnCompositeAlarm.Builder insufficientDataActions(List<String> 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 .

Parameters:

insufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. This parameter is required.

Returns:

this

okActions

@Stability(value=Stable)
public CfnCompositeAlarm.Builder okActions(List<String> 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 .

Parameters:

okActions - The actions to execute when this alarm transitions to the OK state from any other state. This parameter is required.

Returns:

this

build

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

Specified by:

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