AlarmArgs

data class AlarmArgs(val alarmName: Output<String>? = null, val comparisonOperator: Output<String>? = null, val contactProtocols: Output<List<String>>? = null, val datapointsToAlarm: Output<Int>? = null, val evaluationPeriods: Output<Int>? = null, val metricName: Output<String>? = null, val monitoredResourceName: Output<String>? = null, val notificationEnabled: Output<Boolean>? = null, val notificationTriggers: Output<List<String>>? = null, val threshold: Output<Double>? = null, val treatMissingData: Output<String>? = null) : ConvertibleToJava<AlarmArgs>

Resource Type definition for AWS::Lightsail::Alarm

Constructors

Link copied to clipboard
constructor(alarmName: Output<String>? = null, comparisonOperator: Output<String>? = null, contactProtocols: Output<List<String>>? = null, datapointsToAlarm: Output<Int>? = null, evaluationPeriods: Output<Int>? = null, metricName: Output<String>? = null, monitoredResourceName: Output<String>? = null, notificationEnabled: Output<Boolean>? = null, notificationTriggers: Output<List<String>>? = null, threshold: Output<Double>? = null, treatMissingData: Output<String>? = null)

Properties

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

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

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

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

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

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

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

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.

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

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.

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

The name of the metric to associate with the alarm.

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

The name of the Lightsail resource that the alarm monitors.

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

Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.

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

The alarm states that trigger a notification.

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

The value against which the specified statistic is compared.

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

Sets how this alarm will handle missing data points.

Functions

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