MetricAlarm class
The details about a metric alarm.
Constructors
-
MetricAlarm({bool? actionsEnabled, List<
String> ? alarmActions, String? alarmArn, DateTime? alarmConfigurationUpdatedTimestamp, String? alarmDescription, String? alarmName, ComparisonOperator? comparisonOperator, int? datapointsToAlarm, List<Dimension> ? dimensions, String? evaluateLowSampleCountPercentile, int? evaluationPeriods, String? extendedStatistic, List<String> ? insufficientDataActions, String? metricName, List<MetricDataQuery> ? metrics, String? namespace, List<String> ? oKActions, int? period, String? stateReason, String? stateReasonData, DateTime? stateUpdatedTimestamp, StateValue? stateValue, Statistic? statistic, double? threshold, String? thresholdMetricId, String? treatMissingData, StandardUnit? unit}) - MetricAlarm.fromXml(XmlElement elem)
-
factory
Properties
- actionsEnabled → bool?
-
Indicates whether actions should be executed during any changes to the alarm
state.
final
-
alarmActions
→ List<
String> ? -
The actions to execute when this alarm transitions to the
ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).final - alarmArn → String?
-
The Amazon Resource Name (ARN) of the alarm.
final
- alarmConfigurationUpdatedTimestamp → DateTime?
-
The time stamp of the last update to the alarm configuration.
final
- alarmDescription → String?
-
The description of the alarm.
final
- alarmName → String?
-
The name of the alarm.
final
- comparisonOperator → ComparisonOperator?
-
The arithmetic operation to use when comparing the specified statistic and
threshold. The specified statistic value is used as the first operand.
final
- datapointsToAlarm → int?
-
The number of data points that must be breaching to trigger the alarm.
final
-
dimensions
→ List<
Dimension> ? -
The dimensions for the metric associated with the alarm.
final
- evaluateLowSampleCountPercentile → String?
-
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.final - evaluationPeriods → int?
-
The number of periods over which data is compared to the specified
threshold.
final
- extendedStatistic → String?
-
The percentile statistic for the metric associated with the alarm. Specify a
value between p0.0 and p100.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
insufficientDataActions
→ List<
String> ? -
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).final - metricName → String?
-
The name of the metric associated with the alarm, if this is an alarm based
on a single metric.
final
-
metrics
→ List<
MetricDataQuery> ? -
An array of MetricDataQuery structures, used in an alarm based on a metric
math expression. Each structure either retrieves a metric or performs a math
expression. One item in the Metrics array is the math expression that the
alarm watches. This expression by designated by having
ReturnData
set to true.final - namespace → String?
-
The namespace of the metric associated with the alarm.
final
-
oKActions
→ List<
String> ? -
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).final - period → int?
-
The period, in seconds, over which the statistic is applied.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- stateReason → String?
-
An explanation for the alarm state, in text format.
final
- stateReasonData → String?
-
An explanation for the alarm state, in JSON format.
final
- stateUpdatedTimestamp → DateTime?
-
The time stamp of the last update to the alarm state.
final
- stateValue → StateValue?
-
The state value for the alarm.
final
- statistic → Statistic?
-
The statistic for the metric associated with the alarm, other than
percentile. For percentile statistics, use
ExtendedStatistic
.final - threshold → double?
-
The value to compare with the specified statistic.
final
- thresholdMetricId → String?
-
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.final - treatMissingData → String?
-
Sets how this alarm is to handle missing data points. If this parameter is
omitted, the default behavior of
missing
is used.final - unit → StandardUnit?
-
The unit of the metric associated with the alarm.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited