MetricAlarmArgs class

The set of arguments for MetricAlarm. The set of arguments for MetricAlarm.

Constructors

MetricAlarmArgs({Input<bool?>? actionsEnabled, Input<List?>? alarmActions, Input<String?>? alarmDescription, Input<String?>? comparisonOperator, Input<int?>? datapointsToAlarm, Input<Map<String, String>?>? dimensions, Input<String?>? evaluateLowSampleCountPercentiles, Input<MetricAlarmEvaluationCriteria?>? evaluationCriteria, Input<int?>? evaluationInterval, Input<int?>? evaluationPeriods, Input<String?>? extendedStatistic, Input<List?>? insufficientDataActions, Input<String?>? metricName, Input<List<MetricAlarmMetricQuery>?>? metricQueries, Input<String?>? name, Input<String?>? namespace, Input<List?>? okActions, Input<int?>? period, Input<String?>? region, Input<String?>? statistic, Input<Map<String, String>?>? tags, Input<double?>? threshold, Input<String?>? thresholdMetricId, Input<String?>? treatMissingData, Input<String?>? unit})
Creates a new MetricAlarmArgs. actionsEnabled Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to true. alarmActions List of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an ARN. alarmDescription The description for the alarm. comparisonOperator The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold. Additionally, the values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models. datapointsToAlarm The number of data points that must be breaching to trigger the alarm. dimensions The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here. evaluateLowSampleCountPercentiles Used only for alarms based on percentiles. evaluationCriteria The evaluation criteria for PromQL alarms. Cannot be used with traditional metric alarm parameters. evaluationInterval The frequency, in seconds, at which the alarm is evaluated. Valid values are 10, 20, 30, and any multiple of 60. Required when using evaluationCriteria. evaluationPeriods The number of periods over which data is compared to the specified threshold. Required for traditional metric alarms. extendedStatistic The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. insufficientDataActions List of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN. metricName The name for the alarm's associated metric. metricQueries Enables you to create an alarm based on a metric math expression. You may specify at most 20. name The descriptive name for the alarm. This name must be unique within the user's AWS account namespace The namespace for the alarm's associated metric. See docs for the list of namespaces. okActions List of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an ARN. period The period in seconds over which the specified statistic is applied. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. statistic The statistic to apply to the alarm's associated metric. tags A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. threshold The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models. thresholdMetricId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function. treatMissingData Sets how this alarm is to handle missing data points. The following values are supported: missing, ignore, breaching and notBreaching. Defaults to missing. unit The unit for the alarm's associated metric.
const
MetricAlarmArgs.fromMap(Map<String, dynamic> map)
factory

Properties

actionsEnabled → Input<bool?>?
Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to true.
final
alarmActions → Input<List?>?
List of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an ARN.
final
alarmDescription → Input<String?>?
The description for the alarm.
final
comparisonOperator → Input<String?>?
The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold. Additionally, the values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.
final
datapointsToAlarm → Input<int?>?
The number of data points that must be breaching to trigger the alarm.
final
dimensions → Input<Map<String, String>?>?
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
final
evaluateLowSampleCountPercentiles → Input<String?>?
Used only for alarms based on percentiles. If you specify ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported: ignore, and evaluate.
final
evaluationCriteria → Input<MetricAlarmEvaluationCriteria?>?
The evaluation criteria for PromQL alarms. Cannot be used with traditional metric alarm parameters.
final
evaluationInterval → Input<int?>?
The frequency, in seconds, at which the alarm is evaluated. Valid values are 10, 20, 30, and any multiple of 60. Required when using evaluationCriteria.
final
evaluationPeriods → Input<int?>?
The number of periods over which data is compared to the specified threshold. Required for traditional metric alarms.
final
extendedStatistic → Input<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 → Input<List?>?
List of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.
final
metricName → Input<String?>?
The name for the alarm's associated metric. See docs for supported metrics.
final
metricQueries → Input<List<MetricAlarmMetricQuery>?>?
Enables you to create an alarm based on a metric math expression. You may specify at most 20.
final
name → Input<String?>?
The descriptive name for the alarm. This name must be unique within the user's AWS account
final
namespace → Input<String?>?
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
final
okActions → Input<List?>?
List of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an ARN.
final
period → Input<int?>?
The period in seconds over which the specified statistic is applied. Valid values are 10, 20, 30, or any multiple of 60.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
statistic → Input<String?>?
The statistic to apply to the alarm's associated metric. Either of the following is supported: SampleCount, Average, Sum, Minimum, Maximum
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
threshold → Input<double?>?
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
final
thresholdMetricId → Input<String?>?
If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
final
treatMissingData → Input<String?>?
Sets how this alarm is to handle missing data points. The following values are supported: missing, ignore, breaching and notBreaching. Defaults to missing.
final
unit → Input<String?>?
The unit for the alarm's associated metric.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited