Class CfnCompositeAlarmProps.Jsii$Proxy
- All Implemented Interfaces:
CfnCompositeAlarmProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- CfnCompositeAlarmProps
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
ModifierConstructorDescriptionprotected
Jsii$Proxy
(CfnCompositeAlarmProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnCompositeAlarmProps.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.final String
Actions will be suppressed if the suppressor alarm is in theALARM
state.final Number
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of theALARM
state.final Number
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into theALARM
state.The actions to execute when this alarm transitions to the ALARM state from any other state.final String
The description for the composite alarm.final String
The name for the composite alarm.final String
An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.The actions to execute when this alarm transitions to the OK state from any other state.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
-
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
Constructor that initializes the object based on literal property values passed by theCfnCompositeAlarmProps.Builder
.
-
-
Method Details
-
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 . -
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.
-
getActionsSuppressor
Description copied from interface:CfnCompositeAlarmProps
Actions will be suppressed if the suppressor alarm is in theALARM
state.ActionsSuppressor
can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm. -
getActionsSuppressorExtensionPeriod
Description copied from interface:CfnCompositeAlarmProps
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of theALARM
state.After this time, the composite alarm performs its actions.
ExtensionPeriod
is required only whenActionsSuppressor
is specified. -
getActionsSuppressorWaitPeriod
Description copied from interface:CfnCompositeAlarmProps
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into theALARM
state.After this time, the composite alarm performs its actions.
WaitPeriod
is required only whenActionsSuppressor
is specified. -
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 .
-
getAlarmDescription
Description copied from interface:CfnCompositeAlarmProps
The description for the composite alarm. -
getAlarmName
Description copied from interface:CfnCompositeAlarmProps
The name for the composite alarm.This name must be unique within your AWS account.
-
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 .
-
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 .
-
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.
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-