software.amazon.awscdk.services.cloudwatch

Class AlarmBase

java.lang.Object

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

Direct Known Subclasses:

Alarm, CompositeAlarm

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.939Z")
public abstract class AlarmBase
extends Resource
implements IAlarm

The base class for Alarm and CompositeAlarm resources.

Nested Class Summary

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.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AlarmBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	AlarmBase(software.constructs.Construct scope, java.lang.String id)
protected	AlarmBase(software.constructs.Construct scope, java.lang.String id, ResourceProps props)

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 java.util.List<java.lang.String>	getAlarmActionArns()
abstract java.lang.String	getAlarmArn() Alarm ARN (i.e.
abstract java.lang.String	getAlarmName() Name of the alarm.
protected java.util.List<java.lang.String>	getInsufficientDataActionArns()
protected java.util.List<java.lang.String>	getOkActionArns()
java.lang.String	renderAlarmRule() AlarmRule indicating ALARM state for Alarm.
protected void	setAlarmActionArns(java.util.List<java.lang.String> value)
protected void	setInsufficientDataActionArns(java.util.List<java.lang.String> value)
protected void	setOkActionArns(java.util.List<java.lang.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 java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

AlarmBase

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

AlarmBase

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

AlarmBase

protected AlarmBase(software.constructs.Construct scope,
                    java.lang.String id,
                    ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

AlarmBase

protected AlarmBase(software.constructs.Construct scope,
                    java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addAlarmAction

public void addAlarmAction(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

public void addInsufficientDataAction(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

public void addOkAction(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

public java.lang.String renderAlarmRule()

AlarmRule indicating ALARM state for Alarm.

Specified by:

renderAlarmRule in interface IAlarmRule

getAlarmArn

public abstract java.lang.String getAlarmArn()

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

Specified by:

getAlarmArn in interface IAlarm

getAlarmName

public abstract java.lang.String getAlarmName()

Name of the alarm.

Specified by:

getAlarmName in interface IAlarm

getAlarmActionArns

protected java.util.List<java.lang.String> getAlarmActionArns()

setAlarmActionArns

protected void setAlarmActionArns(java.util.List<java.lang.String> value)

getInsufficientDataActionArns

protected java.util.List<java.lang.String> getInsufficientDataActionArns()

setInsufficientDataActionArns

protected void setInsufficientDataActionArns(java.util.List<java.lang.String> value)

getOkActionArns

protected java.util.List<java.lang.String> getOkActionArns()

setOkActionArns

protected void setOkActionArns(java.util.List<java.lang.String> value)