software.amazon.awscdk.services.cloudwatch

Class Alarm

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cloudwatch.AlarmBase

software.amazon.awscdk.services.cloudwatch.Alarm

All Implemented Interfaces:

IConstruct, IDependable, IResource, IAlarm, IAlarmRule

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:35.566Z")
public class Alarm
extends AlarmBase

An alarm on a CloudWatch metric.

Example:

 import software.amazon.awscdk.services.cloudwatch.*;
 Alias alias;
 // or add alarms to an existing group
 Alias blueGreenAlias;
 Alarm alarm = Alarm.Builder.create(this, "Errors")
         .comparisonOperator(ComparisonOperator.GREATER_THAN_THRESHOLD)
         .threshold(1)
         .evaluationPeriods(1)
         .metric(alias.metricErrors())
         .build();
 LambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.Builder.create(this, "BlueGreenDeployment")
         .alias(alias)
         .deploymentConfig(LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE)
         .alarms(List.of(alarm))
         .build();
 deploymentGroup.addAlarm(Alarm.Builder.create(this, "BlueGreenErrors")
         .comparisonOperator(ComparisonOperator.GREATER_THAN_THRESHOLD)
         .threshold(1)
         .evaluationPeriods(1)
         .metric(blueGreenAlias.metricErrors())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Alarm.Builder A fluent builder for Alarm.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.IAlarm

IAlarm.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Alarm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Alarm(software.amazon.jsii.JsiiObjectRef objRef)
	Alarm(software.constructs.Construct scope, java.lang.String id, AlarmProps props)

Method Summary

Modifier and Type	Method and Description
void	addAlarmAction(IAlarmAction... actions) Trigger this action if the alarm fires.
static IAlarm	fromAlarmArn(software.constructs.Construct scope, java.lang.String id, java.lang.String alarmArn) Import an existing CloudWatch alarm provided an ARN.
java.lang.String	getAlarmArn() ARN of this alarm.
java.lang.String	getAlarmName() Name of this alarm.
IMetric	getMetric() The metric object this alarm was based on.
HorizontalAnnotation	toAnnotation() Turn this alarm into a horizontal annotation.

Methods inherited from class software.amazon.awscdk.services.cloudwatch.AlarmBase

addInsufficientDataAction, addOkAction, getAlarmActionArns, getInsufficientDataActionArns, getOkActionArns, renderAlarmRule, setAlarmActionArns, setInsufficientDataActionArns, setOkActionArns

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

Alarm

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

Alarm

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

Alarm

public Alarm(software.constructs.Construct scope,
             java.lang.String id,
             AlarmProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromAlarmArn

public static IAlarm fromAlarmArn(software.constructs.Construct scope,
                                  java.lang.String id,
                                  java.lang.String alarmArn)

Import an existing CloudWatch alarm provided an ARN.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

alarmArn - Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). This parameter is required.

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.

Overrides:

addAlarmAction in class AlarmBase

Parameters:

actions - This parameter is required.

toAnnotation

public HorizontalAnnotation toAnnotation()

Turn this alarm into a horizontal annotation.

This is useful if you want to represent an Alarm in a non-AlarmWidget. An AlarmWidget can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph.

This might be useful if:

• You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm.
• You want to show an Alarm line in a graph with multiple metrics in it.

getAlarmArn

public java.lang.String getAlarmArn()

ARN of this alarm.

Specified by:

getAlarmArn in interface IAlarm

Specified by:

getAlarmArn in class AlarmBase

getAlarmName

public java.lang.String getAlarmName()

Name of this alarm.

Specified by:

getAlarmName in interface IAlarm

Specified by:

getAlarmName in class AlarmBase

getMetric

public IMetric getMetric()

The metric object this alarm was based on.