AWS CloudWatch · Schema

PutMetricAlarmInput

AlarmsAwsDashboardsLogsMetricsMonitoringObservability

Properties

Name Type Description
AlarmName string The name for the alarm.
AlarmDescription string The description for the alarm.
ActionsEnabled boolean Indicates whether actions should be executed during any changes to the alarm state.
OKActions array The actions to execute when this alarm transitions to an OK state.
AlarmActions array The actions to execute when this alarm transitions to the ALARM state.
InsufficientDataActions array The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state.
MetricName string The name for the metric associated with the alarm.
Namespace string The namespace for the metric associated with the alarm.
ExtendedStatistic string The percentile statistic for the metric specified in MetricName.
Dimensions array The dimensions for the metric specified in MetricName.
Period integer The length, in seconds, used each time the metric specified in MetricName is evaluated.
EvaluationPeriods integer The number of periods over which data is compared to the specified threshold.
DatapointsToAlarm integer The number of data points that must be breaching to trigger the alarm.
Threshold number The value against which the specified statistic is compared.
TreatMissingData string Sets how this alarm is to handle missing data points.
EvaluateLowSampleCountPercentile string Used only for alarms based on percentiles.
Metrics array An array of MetricDataQuery structures for metric math expression alarms.
Tags array A list of key-value pairs to associate with the alarm.
ThresholdMetricId string If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
View JSON Schema on GitHub