AnomalyDetectionAlarm
CloudWatch Alarm that uses anomaly detection to trigger alarms. This alarm type is specifically designed for use with anomaly detection operators like LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD.
Import
import { AnomalyDetectionAlarm } from 'aws-cdk-lib/aws-cloudwatch';Or use the module namespace:
import * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';
// cloudwatch.AnomalyDetectionAlarmProperties
Configuration passed to the constructor as AnomalyDetectionAlarmProps.
evaluationPeriodsRequirednumberThe number of periods over which data is compared to the specified threshold.
metricRequiredIMetricThe metric to add the alarm on. Metric objects can be obtained from most resources, or you can construct custom Metric objects by instantiating one.
actionsEnabledOptionalbooleanWhether the actions for this alarm are enabled.
Default: true
alarmDescriptionOptionalstringDescription for the alarm.
Default: No description
alarmNameOptionalstringName of the alarm.
Default: Automatically generated name
comparisonOperatorOptionalComparisonOperatorComparison operator to use to check if metric is breaching. Must be one of the anomaly detection operators: - LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD - GREATER_THAN_UPPER_THRESHOLD - LESS_THAN_LOWER_THRESHOLD
Default: LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD
datapointsToAlarmOptionalnumberThe 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. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.
Default: ``evaluationPeriods``
evaluateLowSampleCountPercentileOptionalstringSpecifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant. Used only for alarms that are based on percentiles.
Default: - Not configured.
periodOptionalDeprecatedDurationThe period over which the specified statistic is applied. Cannot be used with `MathExpression` objects.
Default: - The period from the metric
Deprecated: Use `metric.with({ period: ... })` to encode the period into the Metric object
statisticOptionalDeprecatedstringWhat function to use for aggregating. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" Cannot be used with `MathExpression` objects.
Default: - The statistic from the metric
Deprecated: Use `metric.with({ statistic: ... })` to encode the period into the Metric object
stdDevsOptionalnumberThe number of standard deviations to use for the anomaly detection band. The higher the value, the wider the band. - Must be greater than 0. A value of 0 or negative values would not make sense in the context of calculating standard deviations. - There is no strict maximum value defined, as standard deviations can theoretically extend infinitely. However, in practice, values beyond 5 or 6 standard deviations are rarely used, as they would result in an extremely wide anomaly detection band, potentially missing significant anomalies.
Default: 2
treatMissingDataOptionalTreatMissingDataSets how this alarm is to handle missing data points.
Default: TreatMissingData.Missing
Get the Amazon CloudWatch Cheat Sheet
Everything you need to know about Amazon CloudWatch on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-cloudwatch