Amazon CloudWatch · Schema
Amazon CloudWatch Alarm
Represents an Amazon CloudWatch metric alarm with its associated configuration, state, and notification actions.
AWSCloudWatchMonitoringObservabilityMetricsLogs
Properties
| Name | Type | Description |
|---|---|---|
| alarmName | string | The name of the alarm |
| alarmArn | string | The Amazon Resource Name (ARN) of the alarm |
| alarmDescription | string | The description for the alarm |
| alarmConfigurationUpdatedTimestamp | string | The time stamp of the last update to the alarm configuration |
| actionsEnabled | boolean | Indicates whether actions should be executed during any changes to the alarm state |
| alarmActions | array | The actions to execute when this alarm transitions to the ALARM state |
| okActions | array | The actions to execute when this alarm transitions to the OK state |
| insufficientDataActions | array | The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state |
| stateValue | string | The state value for the alarm |
| stateReason | string | An explanation for the alarm state in human-readable text format |
| stateReasonData | string | An explanation for the alarm state in JSON format |
| stateUpdatedTimestamp | string | The time stamp of the last update to the alarm state |
| metricName | string | The name of the metric associated with the alarm |
| namespace | string | The namespace of the metric associated with the alarm |
| statistic | string | The statistic for the metric specified in MetricName |
| 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 of the evaluation period for the alarm |
| 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 |
| comparisonOperator | string | The arithmetic operation to use when comparing the specified statistic and threshold |
| treatMissingData | string | Sets how this alarm is to handle missing data points |
| unit | string | The unit of measure for the statistic |
| tags | array | Tags associated with the alarm |