Package software.amazon.awscdk.services.cloudwatch

Interface CfnCompositeAlarmProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCompositeAlarmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:04.047Z")
@Stability(Stable)
public interface CfnCompositeAlarmProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCompositeAlarm.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 CfnCompositeAlarmProps cfnCompositeAlarmProps = CfnCompositeAlarmProps.builder()
         .alarmRule("alarmRule")
         // the properties below are optional
         .actionsEnabled(false)
         .actionsSuppressor("actionsSuppressor")
         .actionsSuppressorExtensionPeriod(123)
         .actionsSuppressorWaitPeriod(123)
         .alarmActions(List.of("alarmActions"))
         .alarmDescription("alarmDescription")
         .alarmName("alarmName")
         .insufficientDataActions(List.of("insufficientDataActions"))
         .okActions(List.of("okActions"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCompositeAlarmProps.Builder	A builder for CfnCompositeAlarmProps
static final class	CfnCompositeAlarmProps.Jsii$Proxy	An implementation for CfnCompositeAlarmProps

Method Summary

Modifier and Type	Method	Description
static CfnCompositeAlarmProps.Builder	builder()
default Object	getActionsEnabled()	Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
default String	getActionsSuppressor()	Actions will be suppressed if the suppressor alarm is in the ALARM state.
default Number	getActionsSuppressorExtensionPeriod()	The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.
default Number	getActionsSuppressorWaitPeriod()	The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.
default List<String>	getAlarmActions()	The actions to execute when this alarm transitions to the ALARM state from any other state.
default String	getAlarmDescription()	The description for the composite alarm.
default String	getAlarmName()	The name for the composite alarm.
String	getAlarmRule()	An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
default List<String>	getInsufficientDataActions()	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
default List<String>	getOkActions()	The actions to execute when this alarm transitions to the OK state from any other state.
default List<CfnTag>	getTags()	A list of key-value pairs to associate with the alarm.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarmRule

@Stability(Stable)
@NotNull
String getAlarmRule()

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 .

See Also:

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

getActionsEnabled

@Stability(Stable)
@Nullable
default Object getActionsEnabled()

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

The default is TRUE.

See Also:

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

getActionsSuppressor

@Stability(Stable)
@Nullable
default String getActionsSuppressor()

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.

See Also:

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

getActionsSuppressorExtensionPeriod

@Stability(Stable)
@Nullable
default Number getActionsSuppressorExtensionPeriod()

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.

See Also:

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

getActionsSuppressorWaitPeriod

@Stability(Stable)
@Nullable
default Number getActionsSuppressorWaitPeriod()

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.

See Also:

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

getAlarmActions

@Stability(Stable)
@Nullable
default List<String> getAlarmActions()

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 .

See Also:

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

getAlarmDescription

@Stability(Stable)
@Nullable
default String getAlarmDescription()

The description for the composite alarm.

See Also:

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

getAlarmName

@Stability(Stable)
@Nullable
default String getAlarmName()

The name for the composite alarm.

This name must be unique within your AWS account.

See Also:

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

getInsufficientDataActions

@Stability(Stable)
@Nullable
default List<String> getInsufficientDataActions()

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 .

See Also:

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

getOkActions

@Stability(Stable)
@Nullable
default List<String> getOkActions()

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 .

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

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

builder

@Stability(Stable)
static CfnCompositeAlarmProps.Builder builder()

Returns:

a CfnCompositeAlarmProps.Builder of CfnCompositeAlarmProps