CfnAlarm

java.lang.Object
- software.constructs.Construct
- - 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:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-07-01T09:58:34.307Z")
public class CfnAlarm
extends CfnResource
implements IInspectable

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

The AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA . The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 CfnAlarm cfnAlarm = CfnAlarm.Builder.create(this, "MyCfnAlarm")
         .comparisonOperator("comparisonOperator")
         .evaluationPeriods(123)
         // the properties below are optional
         .actionsEnabled(false)
         .alarmActions(List.of("alarmActions"))
         .alarmDescription("alarmDescription")
         .alarmName("alarmName")
         .datapointsToAlarm(123)
         .dimensions(List.of(DimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .evaluateLowSampleCountPercentile("evaluateLowSampleCountPercentile")
         .extendedStatistic("extendedStatistic")
         .insufficientDataActions(List.of("insufficientDataActions"))
         .metricName("metricName")
         .metrics(List.of(MetricDataQueryProperty.builder()
                 .id("id")
                 // the properties below are optional
                 .accountId("accountId")
                 .expression("expression")
                 .label("label")
                 .metricStat(MetricStatProperty.builder()
                         .metric(MetricProperty.builder()
                                 .dimensions(List.of(DimensionProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .metricName("metricName")
                                 .namespace("namespace")
                                 .build())
                         .period(123)
                         .stat("stat")
                         // the properties below are optional
                         .unit("unit")
                         .build())
                 .period(123)
                 .returnData(false)
                 .build()))
         .namespace("namespace")
         .okActions(List.of("okActions"))
         .period(123)
         .statistic("statistic")
         .threshold(123)
         .thresholdMetricId("thresholdMetricId")
         .treatMissingData("treatMissingData")
         .unit("unit")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnAlarm.Builder` A fluent builder for `CfnAlarm`.
`static interface`	`CfnAlarm.DimensionProperty` Dimension is an embedded property of the `AWS::CloudWatch::Alarm` type.
`static interface`	`CfnAlarm.MetricDataQueryProperty` The `MetricDataQuery` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data.
`static interface`	`CfnAlarm.MetricProperty` The `Metric` property type represents a specific metric.
`static interface`	`CfnAlarm.MetricStatProperty` This structure defines the metric to be returned, along with the statistics, period, and units.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnAlarm(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getActionsEnabled()` Indicates whether actions should be executed during any changes to the alarm state.
`java.util.List<java.lang.String>`	`getAlarmActions()` The list of actions to execute when this alarm transitions into an ALARM state from any other state.
`java.lang.String`	`getAlarmDescription()` The description of the alarm.
`java.lang.String`	`getAlarmName()` The name of the alarm.
`java.lang.String`	`getAttrArn()` The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getComparisonOperator()` The arithmetic operation to use when comparing the specified statistic and threshold.
`java.lang.Number`	`getDatapointsToAlarm()` The number of datapoints that must be breaching to trigger the alarm.
`java.lang.Object`	`getDimensions()` The dimensions for the metric associated with the alarm.
`java.lang.String`	`getEvaluateLowSampleCountPercentile()` Used only for alarms based on percentiles.
`java.lang.Number`	`getEvaluationPeriods()` The number of periods over which data is compared to the specified threshold.
`java.lang.String`	`getExtendedStatistic()` The percentile statistic for the metric associated with the alarm.
`java.util.List<java.lang.String>`	`getInsufficientDataActions()` The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
`java.lang.String`	`getMetricName()` The name of the metric associated with the alarm.
`java.lang.Object`	`getMetrics()` An array that enables you to create an alarm based on the result of a metric math expression.
`java.lang.String`	`getNamespace()` The namespace of the metric associated with the alarm.
`java.util.List<java.lang.String>`	`getOkActions()` The actions to execute when this alarm transitions to the `OK` state from any other state.
`java.lang.Number`	`getPeriod()` The period, in seconds, over which the statistic is applied.
`java.lang.String`	`getStatistic()` The statistic for the metric associated with the alarm, other than percentile.
`java.lang.Number`	`getThreshold()` The value to compare with the specified statistic.
`java.lang.String`	`getThresholdMetricId()` In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.
`java.lang.String`	`getTreatMissingData()` Sets how this alarm is to handle missing data points.
`java.lang.String`	`getUnit()` The unit of the metric associated with the alarm.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setActionsEnabled(java.lang.Boolean value)` Indicates whether actions should be executed during any changes to the alarm state.
`void`	`setActionsEnabled(IResolvable value)` Indicates whether actions should be executed during any changes to the alarm state.
`void`	`setAlarmActions(java.util.List<java.lang.String> value)` The list of actions to execute when this alarm transitions into an ALARM state from any other state.
`void`	`setAlarmDescription(java.lang.String value)` The description of the alarm.
`void`	`setAlarmName(java.lang.String value)` The name of the alarm.
`void`	`setComparisonOperator(java.lang.String value)` The arithmetic operation to use when comparing the specified statistic and threshold.
`void`	`setDatapointsToAlarm(java.lang.Number value)` The number of datapoints that must be breaching to trigger the alarm.
`void`	`setDimensions(IResolvable value)` The dimensions for the metric associated with the alarm.
`void`	`setDimensions(java.util.List<java.lang.Object> value)` The dimensions for the metric associated with the alarm.
`void`	`setEvaluateLowSampleCountPercentile(java.lang.String value)` Used only for alarms based on percentiles.
`void`	`setEvaluationPeriods(java.lang.Number value)` The number of periods over which data is compared to the specified threshold.
`void`	`setExtendedStatistic(java.lang.String value)` The percentile statistic for the metric associated with the alarm.
`void`	`setInsufficientDataActions(java.util.List<java.lang.String> value)` The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
`void`	`setMetricName(java.lang.String value)` The name of the metric associated with the alarm.
`void`	`setMetrics(IResolvable value)` An array that enables you to create an alarm based on the result of a metric math expression.
`void`	`setMetrics(java.util.List<java.lang.Object> value)` An array that enables you to create an alarm based on the result of a metric math expression.
`void`	`setNamespace(java.lang.String value)` The namespace of the metric associated with the alarm.
`void`	`setOkActions(java.util.List<java.lang.String> value)` The actions to execute when this alarm transitions to the `OK` state from any other state.
`void`	`setPeriod(java.lang.Number value)` The period, in seconds, over which the statistic is applied.
`void`	`setStatistic(java.lang.String value)` The statistic for the metric associated with the alarm, other than percentile.
`void`	`setThreshold(java.lang.Number value)` The value to compare with the specified statistic.
`void`	`setThresholdMetricId(java.lang.String value)` In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.
`void`	`setTreatMissingData(java.lang.String value)` Sets how this alarm is to handle missing data points.
`void`	`setUnit(java.lang.String value)` The unit of the metric associated with the alarm.

Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

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, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnAlarm(Construct scope,
                java.lang.String id,
                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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getComparisonOperator
```
public java.lang.String getComparisonOperator()
```
    The arithmetic operation to use when comparing the specified statistic and threshold.
    The specified statistic value is used as the first operand.
    You can specify the following values: GreaterThanThreshold , GreaterThanOrEqualToThreshold , LessThanThreshold , or LessThanOrEqualToThreshold .
  - setComparisonOperator
```
public void setComparisonOperator(java.lang.String value)
```
    The arithmetic operation to use when comparing the specified statistic and threshold.
    The specified statistic value is used as the first operand.
    You can specify the following values: GreaterThanThreshold , GreaterThanOrEqualToThreshold , LessThanThreshold , or LessThanOrEqualToThreshold .
  - getEvaluationPeriods
```
public java.lang.Number getEvaluationPeriods()
```
    The number of periods over which data is compared to the specified threshold.
    If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.
    For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .
  - setEvaluationPeriods
```
public void setEvaluationPeriods(java.lang.Number value)
```
    The number of periods over which data is compared to the specified threshold.
    If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.
    For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .
  - getActionsEnabled
```
public java.lang.Object getActionsEnabled()
```
    Indicates whether actions should be executed during any changes to the alarm state.
    The default is TRUE.
  - setActionsEnabled
```
public void setActionsEnabled(java.lang.Boolean value)
```
    Indicates whether actions should be executed during any changes to the alarm state.
    The default is TRUE.
  - setActionsEnabled
```
public void setActionsEnabled(IResolvable value)
```
    Indicates whether actions should be executed during any changes to the alarm state.
    The default is TRUE.
  - getAlarmActions
```
public java.util.List<java.lang.String> getAlarmActions()
```
    The list of actions to execute when this alarm transitions into an ALARM state from any other state.
    Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutMetricAlarm in the Amazon CloudWatch API Reference .
  - setAlarmActions
```
public void setAlarmActions(java.util.List<java.lang.String> value)
```
    The list of actions to execute when this alarm transitions into an ALARM state from any other state.
    Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutMetricAlarm in the Amazon CloudWatch API Reference .
  - getAlarmDescription
```
public java.lang.String getAlarmDescription()
```
    The description of the alarm.
  - setAlarmDescription
```
public void setAlarmDescription(java.lang.String value)
```
    The description of the alarm.
  - getAlarmName
```
public java.lang.String getAlarmName()
```
    The name of the alarm.
    If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.
    
    If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
  - setAlarmName
```
public void setAlarmName(java.lang.String value)
```
    The name of the alarm.
    If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.
    
    If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
  - getDatapointsToAlarm
```
public java.lang.Number getDatapointsToAlarm()
```
    The number of datapoints that must be breaching to trigger the alarm.
    This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for EvaluationPeriods is the N value. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .
    If you omit this parameter, CloudWatch uses the same value here that you set for EvaluationPeriods , and the alarm goes to alarm state if that many consecutive periods are breaching.
  - setDatapointsToAlarm
```
public void setDatapointsToAlarm(java.lang.Number value)
```
    The number of datapoints that must be breaching to trigger the alarm.
    This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for EvaluationPeriods is the N value. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .
    If you omit this parameter, CloudWatch uses the same value here that you set for EvaluationPeriods , and the alarm goes to alarm state if that many consecutive periods are breaching.
  - getDimensions
```
public java.lang.Object getDimensions()
```
    The dimensions for the metric associated with the alarm.
    For an alarm based on a math expression, you can't specify Dimensions . Instead, you use Metrics .
  - setDimensions
```
public void setDimensions(IResolvable value)
```
    The dimensions for the metric associated with the alarm.
    For an alarm based on a math expression, you can't specify Dimensions . Instead, you use Metrics .
  - setDimensions
```
public void setDimensions(java.util.List<java.lang.Object> value)
```
    The dimensions for the metric associated with the alarm.
    For an alarm based on a math expression, you can't specify Dimensions . Instead, you use Metrics .
  - getEvaluateLowSampleCountPercentile
```
public java.lang.String getEvaluateLowSampleCountPercentile()
```
    Used only for alarms based on percentiles.
    If ignore , the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
  - setEvaluateLowSampleCountPercentile
```
public void setEvaluateLowSampleCountPercentile(java.lang.String value)
```
    Used only for alarms based on percentiles.
    If ignore , the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
  - getExtendedStatistic
```
public java.lang.String getExtendedStatistic()
```
    The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
    For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
    For an alarm based on a math expression, you can't specify ExtendedStatistic . Instead, you use Metrics .
  - setExtendedStatistic
```
public void setExtendedStatistic(java.lang.String value)
```
    The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
    For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
    For an alarm based on a math expression, you can't specify ExtendedStatistic . Instead, you use Metrics .
  - getInsufficientDataActions
```
public java.util.List<java.lang.String> getInsufficientDataActions()
```
    The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
    Each action is specified as an Amazon Resource Name (ARN).
  - setInsufficientDataActions
```
public void setInsufficientDataActions(java.util.List<java.lang.String> value)
```
    The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
    Each action is specified as an Amazon Resource Name (ARN).
  - getMetricName
```
public java.lang.String getMetricName()
```
    The name of the metric associated with the alarm.
    This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName .
  - setMetricName
```
public void setMetricName(java.lang.String value)
```
    The name of the metric associated with the alarm.
    This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName .
  - getMetrics
```
public java.lang.Object getMetrics()
```
    An array that enables you to create an alarm based on the result of a metric math expression.
    Each item in the array either retrieves a metric or performs a math expression.
    If you specify the Metrics parameter, you cannot specify MetricName , Dimensions , Period , Namespace , Statistic , ExtendedStatistic , or Unit .
  - setMetrics
```
public void setMetrics(IResolvable value)
```
    An array that enables you to create an alarm based on the result of a metric math expression.
    Each item in the array either retrieves a metric or performs a math expression.
    If you specify the Metrics parameter, you cannot specify MetricName , Dimensions , Period , Namespace , Statistic , ExtendedStatistic , or Unit .
  - setMetrics
```
public void setMetrics(java.util.List<java.lang.Object> value)
```
    An array that enables you to create an alarm based on the result of a metric math expression.
    Each item in the array either retrieves a metric or performs a math expression.
    If you specify the Metrics parameter, you cannot specify MetricName , Dimensions , Period , Namespace , Statistic , ExtendedStatistic , or Unit .
  - getNamespace
```
public java.lang.String getNamespace()
```
    The namespace of the metric associated with the alarm.
    This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.
    For a list of namespaces for metrics from AWS services, see AWS Services That Publish CloudWatch Metrics.
  - setNamespace
```
public void setNamespace(java.lang.String value)
```
    The namespace of the metric associated with the alarm.
    This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.
    For a list of namespaces for metrics from AWS services, see AWS Services That Publish CloudWatch Metrics.
  - getOkActions
```
public java.util.List<java.lang.String> getOkActions()
```
    The actions to execute when this alarm transitions to the `OK` state from any other state.
    Each action is specified as an Amazon Resource Name (ARN).
  - setOkActions
```
public void setOkActions(java.util.List<java.lang.String> value)
```
    The actions to execute when this alarm transitions to the `OK` state from any other state.
    Each action is specified as an Amazon Resource Name (ARN).
  - getPeriod
```
public java.lang.Number getPeriod()
```
    The period, in seconds, over which the statistic is applied.
    This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
    For an alarm based on a math expression, you can't specify Period , and instead you use the Metrics parameter.
    Minimum: 10
  - setPeriod
```
public void setPeriod(java.lang.Number value)
```
    The period, in seconds, over which the statistic is applied.
    This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
    For an alarm based on a math expression, you can't specify Period , and instead you use the Metrics parameter.
    Minimum: 10
  - getStatistic
```
public java.lang.String getStatistic()
```
    The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use `ExtendedStatistic` .
    For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
    For an alarm based on a math expression, you can't specify Statistic . Instead, you use Metrics .
  - setStatistic
```
public void setStatistic(java.lang.String value)
```
    The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use `ExtendedStatistic` .
    For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
    For an alarm based on a math expression, you can't specify Statistic . Instead, you use Metrics .
  - getThreshold
```
public java.lang.Number getThreshold()
```
    The value to compare with the specified statistic.
  - setThreshold
```
public void setThreshold(java.lang.Number value)
```
    The value to compare with the specified statistic.
  - getThresholdMetricId
```
public java.lang.String getThresholdMetricId()
```
    In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.
  - setThresholdMetricId
```
public void setThresholdMetricId(java.lang.String value)
```
    In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.
  - getTreatMissingData
```
public java.lang.String getTreatMissingData()
```
    Sets how this alarm is to handle missing data points.
    Valid values are breaching , notBreaching , ignore , and missing . For more information, see Configuring How CloudWatch Alarms Treat Missing Data in the Amazon CloudWatch User Guide .
    If you omit this parameter, the default behavior of missing is used.
  - setTreatMissingData
```
public void setTreatMissingData(java.lang.String value)
```
    Sets how this alarm is to handle missing data points.
    Valid values are breaching , notBreaching , ignore , and missing . For more information, see Configuring How CloudWatch Alarms Treat Missing Data in the Amazon CloudWatch User Guide .
    If you omit this parameter, the default behavior of missing is used.
  - getUnit
```
public java.lang.String getUnit()
```
    The unit of the metric associated with the alarm.
    Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.
    You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
  - setUnit
```
public void setUnit(java.lang.String value)
```
    The unit of the metric associated with the alarm.
    Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.
    You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.

Class CfnAlarm

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnAlarm

CfnAlarm

CfnAlarm

Method Detail

inspect

renderProperties

getAttrArn

getCfnProperties

getComparisonOperator

setComparisonOperator

getEvaluationPeriods

setEvaluationPeriods

getActionsEnabled

setActionsEnabled

setActionsEnabled

getAlarmActions

setAlarmActions

getAlarmDescription

setAlarmDescription

getAlarmName

setAlarmName

getDatapointsToAlarm

setDatapointsToAlarm

getDimensions

setDimensions

setDimensions

getEvaluateLowSampleCountPercentile

setEvaluateLowSampleCountPercentile

getExtendedStatistic

setExtendedStatistic

getInsufficientDataActions

setInsufficientDataActions

getMetricName

setMetricName

getMetrics

setMetrics

setMetrics

getNamespace

setNamespace

getOkActions

setOkActions

getPeriod

setPeriod

getStatistic

setStatistic

getThreshold

setThreshold

getThresholdMetricId

setThresholdMetricId

getTreatMissingData

setTreatMissingData

getUnit

setUnit