Package software.amazon.awscdk.services.cloudwatch

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

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	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.
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.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

@Stability(Stable)
public void addAlarmAction(@NotNull
 @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(Stable)
public void addInsufficientDataAction(@NotNull
 @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(Stable)
public void addOkAction(@NotNull
 @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(Stable)
@NotNull
public String renderAlarmRule()

AlarmRule indicating ALARM state for Alarm.

Specified by:

renderAlarmRule in interface IAlarmRule

getAlarmArn

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

Alarm ARN (i.e. arn:aws:cloudwatch::<account-id>:alarm:Foo).

Specified by:

getAlarmArn in interface IAlarm

getAlarmName

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

Name of the alarm.

Specified by:

getAlarmName in interface IAlarm

getAlarmActionArns

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

setAlarmActionArns

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

getInsufficientDataActionArns

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

setInsufficientDataActionArns

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

getOkActionArns

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

setOkActionArns

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