class AlarmBase

Language	Type name
.NET	Amazon.CDK.AWS.CloudWatch.AlarmBase
Java	software.amazon.awscdk.services.cloudwatch.AlarmBase
Python	aws_cdk.aws_cloudwatch.AlarmBase
TypeScript (source)	@aws-cdk/aws-cloudwatch » AlarmBase

Implements IConstruct, IConstruct, IDependable, IResource, IAlarm, IAlarmRule

Extends Resource

Implemented by Alarm, CompositeAlarm

The base class for Alarm and CompositeAlarm resources.

Initializer

new AlarmBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

Properties

Name	Type	Description
alarmArn	string	Alarm ARN (i.e. arn:aws:cloudwatch::<account-id>:alarm:Foo).
alarmName	string	Name of the alarm.
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The stack in which this resource is defined.
alarmActionArns?	string[]
insufficientDataActionArns?	string[]
okActionArns?	string[]

---

alarmArn

Type: string

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

---

alarmName

Type: string

Name of the alarm.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

---

alarmActionArns?

Type: string[] (optional)

---

insufficientDataActionArns?

Type: string[] (optional)

---

okActionArns?

Type: string[] (optional)

Methods

Name	Description
addAlarmAction(...actions)	Trigger this action if the alarm fires.
addInsufficientDataAction(...actions)	Trigger this action if there is insufficient data to evaluate the alarm.
addOkAction(...actions)	Trigger this action if the alarm returns from breaching state into ok state.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
renderAlarmRule()	AlarmRule indicating ALARM state for Alarm.
toString()	Returns a string representation of this construct.

---

addAlarmAction(...actions)

public addAlarmAction(...actions: IAlarmAction[]): void

Parameters

• actions IAlarmAction

Trigger this action if the alarm fires.

Typically the ARN of an SNS topic or ARN of an AutoScaling policy.

---

addInsufficientDataAction(...actions)

public addInsufficientDataAction(...actions: IAlarmAction[]): void

Parameters

• actions IAlarmAction

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.

---

addOkAction(...actions)

public addOkAction(...actions: IAlarmAction[]): void

Parameters

• actions IAlarmAction

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.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

renderAlarmRule()

public renderAlarmRule(): string

Returns

• string

AlarmRule indicating ALARM state for Alarm.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.