Package software.amazon.awscdk.services.cloudwatch

Class CfnCompositeAlarmProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudwatch.CfnCompositeAlarmProps.Jsii$Proxy

All Implemented Interfaces:

CfnCompositeAlarmProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnCompositeAlarmProps

@Stability(Stable)
@Internal
public static final class CfnCompositeAlarmProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnCompositeAlarmProps

An implementation for CfnCompositeAlarmProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.CfnCompositeAlarmProps

CfnCompositeAlarmProps.Builder, CfnCompositeAlarmProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnCompositeAlarmProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnCompositeAlarmProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnCompositeAlarmProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnCompositeAlarmProps.Builder.

Method Details

getAlarmRule

public final String getAlarmRule()

Description copied from interface: CfnCompositeAlarmProps

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 .

Specified by:

getAlarmRule in interface CfnCompositeAlarmProps

See Also:

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

getActionsEnabled

public final Object getActionsEnabled()

Description copied from interface: CfnCompositeAlarmProps

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

The default is TRUE.

Specified by:

getActionsEnabled in interface CfnCompositeAlarmProps

See Also:

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

getActionsSuppressor

public final String getActionsSuppressor()

Description copied from interface: CfnCompositeAlarmProps

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.

Specified by:

getActionsSuppressor in interface CfnCompositeAlarmProps

See Also:

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

getActionsSuppressorExtensionPeriod

public final Number getActionsSuppressorExtensionPeriod()

Description copied from interface: CfnCompositeAlarmProps

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.

Specified by:

getActionsSuppressorExtensionPeriod in interface CfnCompositeAlarmProps

See Also:

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

getActionsSuppressorWaitPeriod

public final Number getActionsSuppressorWaitPeriod()

Description copied from interface: CfnCompositeAlarmProps

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.

Specified by:

getActionsSuppressorWaitPeriod in interface CfnCompositeAlarmProps

See Also:

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

getAlarmActions

public final List<String> getAlarmActions()

Description copied from interface: CfnCompositeAlarmProps

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 .

Specified by:

getAlarmActions in interface CfnCompositeAlarmProps

See Also:

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

getAlarmDescription

public final String getAlarmDescription()

Description copied from interface: CfnCompositeAlarmProps

The description for the composite alarm.

Specified by:

getAlarmDescription in interface CfnCompositeAlarmProps

See Also:

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

getAlarmName

public final String getAlarmName()

Description copied from interface: CfnCompositeAlarmProps

The name for the composite alarm.

This name must be unique within your AWS account.

Specified by:

getAlarmName in interface CfnCompositeAlarmProps

See Also:

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

getInsufficientDataActions

public final List<String> getInsufficientDataActions()

Description copied from interface: CfnCompositeAlarmProps

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 .

Specified by:

getInsufficientDataActions in interface CfnCompositeAlarmProps

See Also:

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

getOkActions

public final List<String> getOkActions()

Description copied from interface: CfnCompositeAlarmProps

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 .

Specified by:

getOkActions in interface CfnCompositeAlarmProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnCompositeAlarmProps

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.

Specified by:

getTags in interface CfnCompositeAlarmProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object