software.amazon.awscdk.services.cloudwatch

Class AlarmBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cloudwatch.AlarmBase

All Implemented Interfaces:

IResource, IAlarm, IAlarmRule, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

Alarm, CompositeAlarm

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.211Z")
 @Stability(value=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.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IAlarm.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlarmBase(software.constructs.Construct scope, String id)
protected	AlarmBase(software.constructs.Construct scope, String id, ResourceProps props)
protected	AlarmBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AlarmBase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addAlarmAction(IAlarmAction... actions) Trigger this action if the alarm fires.
void	addInsufficientDataAction(IAlarmAction... actions) Trigger this action if there is insufficient data to evaluate the alarm.
void	addOkAction(IAlarmAction... actions) Trigger this action if the alarm returns from breaching state into ok state.
protected List<String>	getAlarmActionArns()
abstract String	getAlarmArn() Alarm ARN (i.e.
abstract String	getAlarmName() Name of the alarm.
protected List<String>	getInsufficientDataActionArns()
protected List<String>	getOkActionArns()
String	renderAlarmRule() 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.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, 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.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AlarmBase

protected AlarmBase(software.amazon.jsii.JsiiObjectRef objRef)

AlarmBase

protected AlarmBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AlarmBase

@Stability(value=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(value=Stable)
protected AlarmBase(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addAlarmAction

@Stability(value=Stable)
public void addAlarmAction(@NotNull
                                                    IAlarmAction... actions)

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

@Stability(value=Stable)
public void addInsufficientDataAction(@NotNull
                                                               IAlarmAction... actions)

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

@Stability(value=Stable)
public void addOkAction(@NotNull
                                                 IAlarmAction... actions)

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

@Stability(value=Stable)
 @NotNull
public String renderAlarmRule()

AlarmRule indicating ALARM state for Alarm.

Specified by:

renderAlarmRule in interface IAlarmRule

getAlarmArn

@Stability(value=Stable)
 @NotNull
public abstract String getAlarmArn()

Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo).

Specified by:

getAlarmArn in interface IAlarm

getAlarmName

@Stability(value=Stable)
 @NotNull
public abstract String getAlarmName()

Name of the alarm.

Specified by:

getAlarmName in interface IAlarm

getAlarmActionArns

@Stability(value=Stable)
 @Nullable
protected List<String> getAlarmActionArns()

setAlarmActionArns

@Stability(value=Stable)
protected void setAlarmActionArns(@Nullable
                                                           List<String> value)

getInsufficientDataActionArns

@Stability(value=Stable)
 @Nullable
protected List<String> getInsufficientDataActionArns()

setInsufficientDataActionArns

@Stability(value=Stable)
protected void setInsufficientDataActionArns(@Nullable
                                                                      List<String> value)

getOkActionArns

@Stability(value=Stable)
 @Nullable
protected List<String> getOkActionArns()

setOkActionArns

@Stability(value=Stable)
protected void setOkActionArns(@Nullable
                                                        List<String> value)