software.amazon.awscdk.services.cloudwatch

Class CfnAlarm

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cloudwatch.CfnAlarm

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/0.13.2 (build a2116e9)",
           date="2019-07-01T16:58:11.742Z")
 @Stability(value=Stable)
public class CfnAlarm
extends software.amazon.awscdk.core.CfnResource

A CloudFormation `AWS::CloudWatch::Alarm`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnAlarm.DimensionProperty
static interface	CfnAlarm.MetricDataQueryProperty
static interface	CfnAlarm.MetricProperty
static interface	CfnAlarm.MetricStatProperty

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAlarm(software.amazon.awscdk.core.Construct scope, String id, CfnAlarmProps props) Create a new `AWS::CloudWatch::Alarm`.
protected	CfnAlarm(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
Object	getActionsEnabled() `AWS::CloudWatch::Alarm.ActionsEnabled`.
List<String>	getAlarmActions() `AWS::CloudWatch::Alarm.AlarmActions`.
String	getAlarmDescription() `AWS::CloudWatch::Alarm.AlarmDescription`.
String	getAlarmName() `AWS::CloudWatch::Alarm.AlarmName`.
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
String	getComparisonOperator() `AWS::CloudWatch::Alarm.ComparisonOperator`.
Number	getDatapointsToAlarm() `AWS::CloudWatch::Alarm.DatapointsToAlarm`.
Object	getDimensions() `AWS::CloudWatch::Alarm.Dimensions`.
String	getEvaluateLowSampleCountPercentile() `AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile`.
Number	getEvaluationPeriods() `AWS::CloudWatch::Alarm.EvaluationPeriods`.
String	getExtendedStatistic() `AWS::CloudWatch::Alarm.ExtendedStatistic`.
List<String>	getInsufficientDataActions() `AWS::CloudWatch::Alarm.InsufficientDataActions`.
String	getMetricName() `AWS::CloudWatch::Alarm.MetricName`.
Object	getMetrics() `AWS::CloudWatch::Alarm.Metrics`.
String	getNamespace() `AWS::CloudWatch::Alarm.Namespace`.
List<String>	getOkActions() `AWS::CloudWatch::Alarm.OKActions`.
Number	getPeriod() `AWS::CloudWatch::Alarm.Period`.
String	getStatistic() `AWS::CloudWatch::Alarm.Statistic`.
Number	getThreshold() `AWS::CloudWatch::Alarm.Threshold`.
String	getTreatMissingData() `AWS::CloudWatch::Alarm.TreatMissingData`.
String	getUnit() `AWS::CloudWatch::Alarm.Unit`.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActionsEnabled(Boolean value) `AWS::CloudWatch::Alarm.ActionsEnabled`.
void	setActionsEnabled(software.amazon.awscdk.core.IResolvable value) `AWS::CloudWatch::Alarm.ActionsEnabled`.
void	setAlarmActions(List<String> value) `AWS::CloudWatch::Alarm.AlarmActions`.
void	setAlarmDescription(String value) `AWS::CloudWatch::Alarm.AlarmDescription`.
void	setAlarmName(String value) `AWS::CloudWatch::Alarm.AlarmName`.
void	setComparisonOperator(String value) `AWS::CloudWatch::Alarm.ComparisonOperator`.
void	setDatapointsToAlarm(Number value) `AWS::CloudWatch::Alarm.DatapointsToAlarm`.
void	setDimensions(software.amazon.awscdk.core.IResolvable value) `AWS::CloudWatch::Alarm.Dimensions`.
void	setDimensions(List<Object> value) `AWS::CloudWatch::Alarm.Dimensions`.
void	setEvaluateLowSampleCountPercentile(String value) `AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile`.
void	setEvaluationPeriods(Number value) `AWS::CloudWatch::Alarm.EvaluationPeriods`.
void	setExtendedStatistic(String value) `AWS::CloudWatch::Alarm.ExtendedStatistic`.
void	setInsufficientDataActions(List<String> value) `AWS::CloudWatch::Alarm.InsufficientDataActions`.
void	setMetricName(String value) `AWS::CloudWatch::Alarm.MetricName`.
void	setMetrics(software.amazon.awscdk.core.IResolvable value) `AWS::CloudWatch::Alarm.Metrics`.
void	setMetrics(List<Object> value) `AWS::CloudWatch::Alarm.Metrics`.
void	setNamespace(String value) `AWS::CloudWatch::Alarm.Namespace`.
void	setOkActions(List<String> value) `AWS::CloudWatch::Alarm.OKActions`.
void	setPeriod(Number value) `AWS::CloudWatch::Alarm.Period`.
void	setStatistic(String value) `AWS::CloudWatch::Alarm.Statistic`.
void	setThreshold(Number value) `AWS::CloudWatch::Alarm.Threshold`.
void	setTreatMissingData(String value) `AWS::CloudWatch::Alarm.TreatMissingData`.
void	setUnit(String value) `AWS::CloudWatch::Alarm.Unit`.

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

addDeletionOverride, addDependsOn, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getUpdatedProperites, isCfnResource, toString, validateProperties

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

getRef

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

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, prepare

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

getNode, isConstruct, synthesize, 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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAlarm

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

CfnAlarm

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

Create a new `AWS::CloudWatch::Alarm`. EXPERIMENTAL

Parameters:

scope - - scope in which this resource is defined.

id - - scoped id of the resource.

props - - resource properties.

Method Detail

renderProperties

@Stability(value=Stable)
protected Map<String,Object> renderProperties(Map<String,Object> props)

Overrides:

renderProperties in class software.amazon.awscdk.core.CfnResource

getAttrArn

@Stability(value=Stable)
public String getAttrArn()

getCfnProperties

@Stability(value=Stable)
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class software.amazon.awscdk.core.CfnResource

getComparisonOperator

@Stability(value=Stable)
public String getComparisonOperator()

`AWS::CloudWatch::Alarm.ComparisonOperator`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-comparisonoperator

setComparisonOperator

@Stability(value=Stable)
public void setComparisonOperator(String value)

`AWS::CloudWatch::Alarm.ComparisonOperator`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-comparisonoperator

getEvaluationPeriods

@Stability(value=Stable)
public Number getEvaluationPeriods()

`AWS::CloudWatch::Alarm.EvaluationPeriods`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluationperiods

setEvaluationPeriods

@Stability(value=Stable)
public void setEvaluationPeriods(Number value)

`AWS::CloudWatch::Alarm.EvaluationPeriods`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluationperiods

getThreshold

@Stability(value=Stable)
public Number getThreshold()

`AWS::CloudWatch::Alarm.Threshold`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-threshold

setThreshold

@Stability(value=Stable)
public void setThreshold(Number value)

`AWS::CloudWatch::Alarm.Threshold`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-threshold

getActionsEnabled

@Stability(value=Stable)
 @Nullable
public Object getActionsEnabled()

`AWS::CloudWatch::Alarm.ActionsEnabled`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled

setActionsEnabled

@Stability(value=Stable)
public void setActionsEnabled(@Nullable
                                                       Boolean value)

`AWS::CloudWatch::Alarm.ActionsEnabled`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled

setActionsEnabled

@Stability(value=Stable)
public void setActionsEnabled(@Nullable
                                                       software.amazon.awscdk.core.IResolvable value)

`AWS::CloudWatch::Alarm.ActionsEnabled`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled

getAlarmActions

@Stability(value=Stable)
 @Nullable
public List<String> getAlarmActions()

`AWS::CloudWatch::Alarm.AlarmActions`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions

setAlarmActions

@Stability(value=Stable)
public void setAlarmActions(@Nullable
                                                     List<String> value)

`AWS::CloudWatch::Alarm.AlarmActions`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions

getAlarmDescription

@Stability(value=Stable)
 @Nullable
public String getAlarmDescription()

`AWS::CloudWatch::Alarm.AlarmDescription`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmdescription

setAlarmDescription

@Stability(value=Stable)
public void setAlarmDescription(@Nullable
                                                         String value)

`AWS::CloudWatch::Alarm.AlarmDescription`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmdescription

getAlarmName

@Stability(value=Stable)
 @Nullable
public String getAlarmName()

`AWS::CloudWatch::Alarm.AlarmName`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmname

setAlarmName

@Stability(value=Stable)
public void setAlarmName(@Nullable
                                                  String value)

`AWS::CloudWatch::Alarm.AlarmName`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmname

getDatapointsToAlarm

@Stability(value=Stable)
 @Nullable
public Number getDatapointsToAlarm()

`AWS::CloudWatch::Alarm.DatapointsToAlarm`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm

setDatapointsToAlarm

@Stability(value=Stable)
public void setDatapointsToAlarm(@Nullable
                                                          Number value)

`AWS::CloudWatch::Alarm.DatapointsToAlarm`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm

getDimensions

@Stability(value=Stable)
 @Nullable
public Object getDimensions()

`AWS::CloudWatch::Alarm.Dimensions`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension

setDimensions

@Stability(value=Stable)
public void setDimensions(@Nullable
                                                   software.amazon.awscdk.core.IResolvable value)

`AWS::CloudWatch::Alarm.Dimensions`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension

setDimensions

@Stability(value=Stable)
public void setDimensions(@Nullable
                                                   List<Object> value)

`AWS::CloudWatch::Alarm.Dimensions`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension

getEvaluateLowSampleCountPercentile

@Stability(value=Stable)
 @Nullable
public String getEvaluateLowSampleCountPercentile()

`AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile

setEvaluateLowSampleCountPercentile

@Stability(value=Stable)
public void setEvaluateLowSampleCountPercentile(@Nullable
                                                                         String value)

`AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile

getExtendedStatistic

@Stability(value=Stable)
 @Nullable
public String getExtendedStatistic()

`AWS::CloudWatch::Alarm.ExtendedStatistic`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic

setExtendedStatistic

@Stability(value=Stable)
public void setExtendedStatistic(@Nullable
                                                          String value)

`AWS::CloudWatch::Alarm.ExtendedStatistic`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic

getInsufficientDataActions

@Stability(value=Stable)
 @Nullable
public List<String> getInsufficientDataActions()

`AWS::CloudWatch::Alarm.InsufficientDataActions`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions

setInsufficientDataActions

@Stability(value=Stable)
public void setInsufficientDataActions(@Nullable
                                                                List<String> value)

`AWS::CloudWatch::Alarm.InsufficientDataActions`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions

getMetricName

@Stability(value=Stable)
 @Nullable
public String getMetricName()

`AWS::CloudWatch::Alarm.MetricName`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-metricname

setMetricName

@Stability(value=Stable)
public void setMetricName(@Nullable
                                                   String value)

`AWS::CloudWatch::Alarm.MetricName`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-metricname

getMetrics

@Stability(value=Stable)
 @Nullable
public Object getMetrics()

`AWS::CloudWatch::Alarm.Metrics`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-metrics

setMetrics

@Stability(value=Stable)
public void setMetrics(@Nullable
                                                software.amazon.awscdk.core.IResolvable value)

`AWS::CloudWatch::Alarm.Metrics`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-metrics

setMetrics

@Stability(value=Stable)
public void setMetrics(@Nullable
                                                List<Object> value)

`AWS::CloudWatch::Alarm.Metrics`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-metrics

getNamespace

@Stability(value=Stable)
 @Nullable
public String getNamespace()

`AWS::CloudWatch::Alarm.Namespace`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-namespace

setNamespace

@Stability(value=Stable)
public void setNamespace(@Nullable
                                                  String value)

`AWS::CloudWatch::Alarm.Namespace`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-namespace

getOkActions

@Stability(value=Stable)
 @Nullable
public List<String> getOkActions()

`AWS::CloudWatch::Alarm.OKActions`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions

setOkActions

@Stability(value=Stable)
public void setOkActions(@Nullable
                                                  List<String> value)

`AWS::CloudWatch::Alarm.OKActions`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions

getPeriod

@Stability(value=Stable)
 @Nullable
public Number getPeriod()

`AWS::CloudWatch::Alarm.Period`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-period

setPeriod

@Stability(value=Stable)
public void setPeriod(@Nullable
                                               Number value)

`AWS::CloudWatch::Alarm.Period`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-period

getStatistic

@Stability(value=Stable)
 @Nullable
public String getStatistic()

`AWS::CloudWatch::Alarm.Statistic`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-statistic

setStatistic

@Stability(value=Stable)
public void setStatistic(@Nullable
                                                  String value)

`AWS::CloudWatch::Alarm.Statistic`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-statistic

getTreatMissingData

@Stability(value=Stable)
 @Nullable
public String getTreatMissingData()

`AWS::CloudWatch::Alarm.TreatMissingData`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-treatmissingdata

setTreatMissingData

@Stability(value=Stable)
public void setTreatMissingData(@Nullable
                                                         String value)

`AWS::CloudWatch::Alarm.TreatMissingData`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-treatmissingdata

getUnit

@Stability(value=Stable)
 @Nullable
public String getUnit()

`AWS::CloudWatch::Alarm.Unit`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-unit

setUnit

@Stability(value=Stable)
public void setUnit(@Nullable
                                             String value)

`AWS::CloudWatch::Alarm.Unit`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-unit