Class AlarmBase
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.Resource
software.amazon.awscdk.services.cloudwatch.AlarmBase
- All Implemented Interfaces:
IConstruct
,IDependable
,IResource
,IAlarm
,IAlarmRule
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
- Direct Known Subclasses:
Alarm
,CompositeAlarm
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:36.766Z")
@Stability(Stable)
public abstract class AlarmBase
extends Resource
implements IAlarm
The base class for Alarm and CompositeAlarm resources.
-
Nested Class Summary
Nested classes/interfaces inherited from class software.constructs.Construct
software.constructs.Construct.Builder
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.IAlarm
IAlarm.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default
-
Constructor Summary
ModifierConstructorDescriptionprotected
AlarmBase
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
AlarmBase
(software.amazon.jsii.JsiiObjectRef objRef) protected
protected
AlarmBase
(software.constructs.Construct scope, String id, ResourceProps props) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAlarmAction
(@NotNull IAlarmAction... actions) Trigger this action if the alarm fires.void
addInsufficientDataAction
(@NotNull IAlarmAction... actions) Trigger this action if there is insufficient data to evaluate the alarm.void
addOkAction
(@NotNull IAlarmAction... actions) Trigger this action if the alarm returns from breaching state into ok state.abstract String
Alarm ARN (i.e.abstract String
Name of the alarm.AlarmRule indicating ALARM state for Alarm.protected void
setAlarmActionArns
(List<String> value) protected void
setInsufficientDataActionArns
(List<String> value) protected void
setOkActionArns
(List<String> value) Methods inherited from class software.amazon.awscdk.core.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.constructs.Construct
toString
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
AlarmBase
protected AlarmBase(software.amazon.jsii.JsiiObjectRef objRef) -
AlarmBase
protected AlarmBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
AlarmBase
@Stability(Stable) protected AlarmBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
-
-
AlarmBase
@Stability(Stable) protected AlarmBase(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.
-
-
Method Details
-
addAlarmAction
Trigger this action if the alarm fires.Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
- Parameters:
actions
- This parameter is required.
-
addInsufficientDataAction
Trigger this action if there is insufficient data to evaluate the alarm.Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
- Parameters:
actions
- This parameter is required.
-
addOkAction
Trigger this action if the alarm returns from breaching state into ok state.Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
- Parameters:
actions
- This parameter is required.
-
renderAlarmRule
AlarmRule indicating ALARM state for Alarm.- Specified by:
renderAlarmRule
in interfaceIAlarmRule
-
getAlarmArn
Alarm ARN (i.e. arn:aws:cloudwatch::<account-id>:alarm:Foo). - Specified by:
getAlarmArn
in interfaceIAlarm
-
getAlarmName
Name of the alarm.- Specified by:
getAlarmName
in interfaceIAlarm
-
getAlarmActionArns
-
setAlarmActionArns
-
getInsufficientDataActionArns
-
setInsufficientDataActionArns
-
getOkActionArns
-
setOkActionArns
-