software.amazon.awscdk.services.cloudwatch

Class Alarm

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cloudwatch.Alarm

All Implemented Interfaces:

software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IResource, IAlarm, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.13.2 (build a2116e9)",
           date="2019-07-01T16:58:11.734Z")
 @Stability(value=Experimental)
public class Alarm
extends software.amazon.awscdk.core.Resource
implements IAlarm

An alarm on a CloudWatch metric. EXPERIMENTAL

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IAlarm.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Alarm(software.amazon.awscdk.core.Construct scope, String id, AlarmProps props) EXPERIMENTAL
protected	Alarm(software.amazon.jsii.JsiiObject.InitializationMode mode)

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.
static IAlarm	fromAlarmArn(software.amazon.awscdk.core.Construct scope, String id, String alarmArn) EXPERIMENTAL
String	getAlarmArn() ARN of this alarm.
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.core.Resource

getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, prepare, synthesize, toString, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

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

getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Alarm

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

Alarm

@Stability(value=Experimental)
public Alarm(software.amazon.awscdk.core.Construct scope,
                                            String id,
                                            AlarmProps props)

EXPERIMENTAL

Method Detail

fromAlarmArn

@Stability(value=Experimental)
public static IAlarm fromAlarmArn(software.amazon.awscdk.core.Construct scope,
                                                                 String id,
                                                                 String alarmArn)

EXPERIMENTAL

addAlarmAction

@Stability(value=Experimental)
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. EXPERIMENTAL

addInsufficientDataAction

@Stability(value=Experimental)
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. EXPERIMENTAL

addOkAction

@Stability(value=Experimental)
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. EXPERIMENTAL

toAnnotation

@Stability(value=Experimental)
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. EXPERIMENTAL

getAlarmArn

@Stability(value=Experimental)
public String getAlarmArn()

ARN of this alarm. EXPERIMENTAL

Specified by:

getAlarmArn in interface IAlarm

getAlarmName

@Stability(value=Experimental)
public String getAlarmName()

Name of this alarm. EXPERIMENTAL

Specified by:

getAlarmName in interface IAlarm

getMetric

@Stability(value=Experimental)
public IMetric getMetric()

The metric object this alarm was based on. EXPERIMENTAL