interface IAlarm

Language	Type name
.NET	Amazon.CDK.AWS.CloudWatch.IAlarm
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#IAlarm
Java	software.amazon.awscdk.services.cloudwatch.IAlarm
Python	aws_cdk.aws_cloudwatch.IAlarm
TypeScript (source)	aws-cdk-lib » aws_cloudwatch » IAlarm

Implemented by Alarm, AnomalyDetectionAlarm, CompositeAlarm

Obtainable from Alarm.fromAlarmArn(), Alarm.fromAlarmName(), CompositeAlarm.fromCompositeAlarmArn(), CompositeAlarm.fromCompositeAlarmName()

Represents a CloudWatch Alarm.

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	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

alarmArn

Type: string

Alarm ARN (i.e. arn:aws:cloudwatch:<region>:<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 in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
renderAlarmRule()	serialized representation of Alarm Rule to be used when building the Composite Alarm resource.

---

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

serialized representation of Alarm Rule to be used when building the Composite Alarm resource.