aws-cdk-lib.aws_cloudwatch.AlarmBase

class AlarmBase

LanguageType name
.NETAmazon.CDK.AWS.CloudWatch.AlarmBase
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#AlarmBase
Javasoftware.amazon.awscdk.services.cloudwatch.AlarmBase
Pythonaws_cdk.aws_cloudwatch.AlarmBase
TypeScript (source)aws-cdk-lib » aws_cloudwatch » AlarmBase

Implements 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

NameTypeDescription
alarmArnstringAlarm ARN (i.e. arn:aws:cloudwatch::<account-id>:alarm:Foo).
alarmNamestringName of the alarm.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe 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: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.


alarmActionArns?

Type: string[] (optional)


insufficientDataActionArns?

Type: string[] (optional)


okActionArns?

Type: string[] (optional)

Methods

NameDescription
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 SnsAcion or AutoScalingAction.


addInsufficientDataAction(...actions)

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

Parameters

  • actions IAlarmAction

Trigger this action if there is insufficient data to evaluate the alarm.

Typically SnsAcion or AutoScalingAction.


addOkAction(...actions)

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

Parameters

  • actions IAlarmAction

Trigger this action if the alarm returns from breaching state into ok state.

Typically SnsAcion or AutoScalingAction.


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.