software.amazon.awscdk.services.cloudwatch

Class CfnAlarm

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cloudwatch.CfnAlarm

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:01.271Z")
 @Stability(value=Stable)
public class CfnAlarm
extends CfnResource
implements IInspectable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAlarm.Builder A fluent builder for CfnAlarm.
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

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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.constructs.Construct scope, String id, CfnAlarmProps props) Create a new `AWS::CloudWatch::Alarm`.
protected	CfnAlarm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAlarm(software.amazon.jsii.JsiiObjectRef objRef)

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	getThresholdMetricId() `AWS::CloudWatch::Alarm.ThresholdMetricId`.
String	getTreatMissingData() `AWS::CloudWatch::Alarm.TreatMissingData`.
String	getUnit() `AWS::CloudWatch::Alarm.Unit`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActionsEnabled(Boolean value) `AWS::CloudWatch::Alarm.ActionsEnabled`.
void	setActionsEnabled(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(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(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	setThresholdMetricId(String value) `AWS::CloudWatch::Alarm.ThresholdMetricId`.
void	setTreatMissingData(String value) `AWS::CloudWatch::Alarm.TreatMissingData`.
void	setUnit(String value) `AWS::CloudWatch::Alarm.Unit`.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, 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.JsiiObjectRef objRef)

CfnAlarm

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

CfnAlarm

@Stability(value=Stable)
public CfnAlarm(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnAlarmProps props)

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

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

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

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getComparisonOperator

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

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

setComparisonOperator

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

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

getEvaluationPeriods

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

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

setEvaluationPeriods

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

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

getActionsEnabled

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

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

setActionsEnabled

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

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

setActionsEnabled

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

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

getAlarmActions

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

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

setAlarmActions

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

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

getAlarmDescription

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

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

setAlarmDescription

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

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

getAlarmName

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

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

setAlarmName

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

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

getDatapointsToAlarm

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

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

setDatapointsToAlarm

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

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

getDimensions

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

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

setDimensions

@Stability(value=Stable)
public void setDimensions(@Nullable
                                                   IResolvable value)

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

setDimensions

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

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

getEvaluateLowSampleCountPercentile

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

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

setEvaluateLowSampleCountPercentile

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

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

getExtendedStatistic

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

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

setExtendedStatistic

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

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

getInsufficientDataActions

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

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

setInsufficientDataActions

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

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

getMetricName

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

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

setMetricName

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

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

getMetrics

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

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

setMetrics

@Stability(value=Stable)
public void setMetrics(@Nullable
                                                IResolvable value)

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

setMetrics

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

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

getNamespace

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

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

setNamespace

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

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

getOkActions

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

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

setOkActions

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

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

getPeriod

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

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

setPeriod

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

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

getStatistic

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

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

setStatistic

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

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

getThreshold

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

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

setThreshold

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

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

getThresholdMetricId

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

`AWS::CloudWatch::Alarm.ThresholdMetricId`.

setThresholdMetricId

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

`AWS::CloudWatch::Alarm.ThresholdMetricId`.

getTreatMissingData

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

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

setTreatMissingData

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

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

getUnit

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

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

setUnit

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

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