AwsCloudWatchAlarmDetails
Specifies an alarm and associates it with the specified metric or metric math expression.
Contents
- ActionsEnabled
-
Indicates whether actions should be executed during any changes to the alarm state.
Type: Boolean
Required: No
- AlarmActions
-
The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an
ALARM
state from any other state.Type: Array of strings
Pattern:
.*\S.*
Required: No
- AlarmArn
-
The ARN of the alarm.
Type: String
Pattern:
.*\S.*
Required: No
- AlarmConfigurationUpdatedTimestamp
-
The time stamp of the last update to the alarm configuration.
Type: String
Pattern:
.*\S.*
Required: No
- AlarmDescription
-
The description of the alarm.
Type: String
Pattern:
.*\S.*
Required: No
- AlarmName
-
The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.
Type: String
Pattern:
.*\S.*
Required: No
- ComparisonOperator
-
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
Type: String
Pattern:
.*\S.*
Required: No
- DatapointsToAlarm
-
The number of datapoints that must be breaching to trigger the alarm.
Type: Integer
Required: No
- Dimensions
-
The dimensions for the metric associated with the alarm.
Type: Array of AwsCloudWatchAlarmDimensionsDetails objects
Required: No
- EvaluateLowSampleCountPercentile
-
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. Ifevaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.Type: String
Pattern:
.*\S.*
Required: No
- EvaluationPeriods
-
The number of periods over which data is compared to the specified threshold.
Type: Integer
Required: No
- ExtendedStatistic
-
The percentile statistic for the metric associated with the alarm.
Type: String
Pattern:
.*\S.*
Required: No
- InsufficientDataActions
-
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA
state from any other state. Each action is specified as an ARN.Type: Array of strings
Pattern:
.*\S.*
Required: No
- MetricName
-
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 specifyMetricName
.Type: String
Pattern:
.*\S.*
Required: No
- Namespace
-
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 useMetrics
instead.Type: String
Pattern:
.*\S.*
Required: No
- OkActions
-
The actions to execute when this alarm transitions to the
OK
state from any other state. Each action is specified as an ARN.Type: Array of strings
Pattern:
.*\S.*
Required: No
- Period
-
The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.
Type: Integer
Required: No
- Statistic
-
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
orExtendedStatistic
but not both.For an alarm based on a math expression, you can't specify
Statistic
. Instead, you useMetrics
.Type: String
Pattern:
.*\S.*
Required: No
- Threshold
-
The value to compare with the specified statistic.
Type: Double
Required: No
- ThresholdMetricId
-
n 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.Type: String
Pattern:
.*\S.*
Required: No
- TreatMissingData
-
Sets how this alarm is to handle missing data points.
Type: String
Pattern:
.*\S.*
Required: No
- Unit
-
The unit of the metric associated with the alarm.
Type: String
Pattern:
.*\S.*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: