pulumi-aws-native-kotlin/com.pulumi.awsnative.cloudwatch.kotlin/AlarmArgs

AlarmArgs

data class AlarmArgs(val actionsEnabled: Output<Boolean>? = null, val alarmActions: Output<List<String>>? = null, val alarmDescription: Output<String>? = null, val alarmName: Output<String>? = null, val comparisonOperator: Output<String>? = null, val datapointsToAlarm: Output<Int>? = null, val dimensions: Output<List<AlarmDimensionArgs>>? = null, val evaluateLowSampleCountPercentile: Output<String>? = null, val evaluationPeriods: Output<Int>? = null, val extendedStatistic: Output<String>? = null, val insufficientDataActions: Output<List<String>>? = null, val metricName: Output<String>? = null, val metrics: Output<List<AlarmMetricDataQueryArgs>>? = null, val namespace: Output<String>? = null, val okActions: Output<List<String>>? = null, val period: Output<Int>? = null, val statistic: Output<String>? = null, val threshold: Output<Double>? = null, val thresholdMetricId: Output<String>? = null, val treatMissingData: Output<String>? = null, val unit: Output<String>? = null) : ConvertibleToJava<AlarmArgs>

Resource Type definition for AWS::CloudWatch::Alarm

Constructors

Link copied to clipboard
fun AlarmArgs(actionsEnabled: Output<Boolean>? = null, alarmActions: Output<List<String>>? = null, alarmDescription: Output<String>? = null, alarmName: Output<String>? = null, comparisonOperator: Output<String>? = null, datapointsToAlarm: Output<Int>? = null, dimensions: Output<List<AlarmDimensionArgs>>? = null, evaluateLowSampleCountPercentile: Output<String>? = null, evaluationPeriods: Output<Int>? = null, extendedStatistic: Output<String>? = null, insufficientDataActions: Output<List<String>>? = null, metricName: Output<String>? = null, metrics: Output<List<AlarmMetricDataQueryArgs>>? = null, namespace: Output<String>? = null, okActions: Output<List<String>>? = null, period: Output<Int>? = null, statistic: Output<String>? = null, threshold: Output<Double>? = null, thresholdMetricId: Output<String>? = null, treatMissingData: Output<String>? = null, unit: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): AlarmArgs

Properties

Link copied to clipboard
val actionsEnabled: Output<Boolean>? = null

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

Link copied to clipboard
val alarmActions: Output<List<String>>? = null

The list of actions to execute when this alarm transitions into an ALARM state from any other state.

Link copied to clipboard
val alarmDescription: Output<String>? = null

The description of the alarm.

Link copied to clipboard
val alarmName: Output<String>? = null

The name of the alarm.

Link copied to clipboard
val comparisonOperator: Output<String>? = null

The arithmetic operation to use when comparing the specified statistic and threshold.

Link copied to clipboard
val datapointsToAlarm: Output<Int>? = null

The number of datapoints that must be breaching to trigger the alarm.

Link copied to clipboard
val dimensions: Output<List<AlarmDimensionArgs>>? = null

The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.

Link copied to clipboard
val evaluateLowSampleCountPercentile: Output<String>? = null

Used only for alarms based on percentiles.

Link copied to clipboard
val evaluationPeriods: Output<Int>? = null

The number of periods over which data is compared to the specified threshold.

Link copied to clipboard
val extendedStatistic: Output<String>? = null

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

Link copied to clipboard
val insufficientDataActions: Output<List<String>>? = null

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.

Link copied to clipboard
val metricName: Output<String>? = null

The name of the metric associated with the alarm.

Link copied to clipboard
val metrics: Output<List<AlarmMetricDataQueryArgs>>? = null

An array that enables you to create an alarm based on the result of a metric math expression.

Link copied to clipboard
val namespace: Output<String>? = null

The namespace of the metric associated with the alarm.

Link copied to clipboard
val okActions: Output<List<String>>? = null

The actions to execute when this alarm transitions to the OK state from any other state.

Link copied to clipboard
val period: Output<Int>? = null

The period in seconds, over which the statistic is applied.

Link copied to clipboard
val statistic: Output<String>? = null

The statistic for the metric associated with the alarm, other than percentile.

Link copied to clipboard
val threshold: Output<Double>? = null

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.

Link copied to clipboard
val thresholdMetricId: Output<String>? = null

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.

Link copied to clipboard
val treatMissingData: Output<String>? = null

Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.

Link copied to clipboard
val unit: Output<String>? = null

The unit of the metric associated with the alarm.