Package 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(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	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)	Actions will be suppressed if the suppressor alarm is in the ALARM state.
CfnCompositeAlarm.Builder	actionsSuppressorExtensionPeriod(Number actionsSuppressorExtensionPeriod)	The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.
CfnCompositeAlarm.Builder	actionsSuppressorWaitPeriod(Number actionsSuppressorWaitPeriod)	The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.
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.
CfnCompositeAlarm.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs to associate with the alarm.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCompositeAlarm.Builder.

alarmRule

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmrule

actionsEnabled

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled

actionsEnabled

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled

actionsSuppressor

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressor

actionsSuppressorExtensionPeriod

@Stability(Stable)
public CfnCompositeAlarm.Builder actionsSuppressorExtensionPeriod(Number 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.

Parameters:

actionsSuppressorExtensionPeriod - The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorextensionperiod

actionsSuppressorWaitPeriod

@Stability(Stable)
public CfnCompositeAlarm.Builder actionsSuppressorWaitPeriod(Number 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.

Parameters:

actionsSuppressorWaitPeriod - The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorwaitperiod

alarmActions

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmactions

alarmDescription

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmdescription

alarmName

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmname

insufficientDataActions

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-insufficientdataactions

okActions

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-okactions

tags

@Stability(Stable)
public CfnCompositeAlarm.Builder tags(List<? extends CfnTag> 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.

Parameters:

tags - A list of key-value pairs to associate with the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-tags

build

@Stability(Stable)
public CfnCompositeAlarm build()

Specified by:

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

Returns:

a newly built instance of CfnCompositeAlarm.