GetAlarmResult

data class GetAlarmResult(val alarmArn: String? = null, val comparisonOperator: String? = null, val contactProtocols: List<String>? = null, val datapointsToAlarm: Int? = null, val evaluationPeriods: Int? = null, val notificationEnabled: Boolean? = null, val notificationTriggers: List<String>? = null, val state: String? = null, val threshold: Double? = null, val treatMissingData: String? = null)

Constructors

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

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val alarmArn: String? = null

The Amazon Resource Name (ARN) of the alarm.

Link copied to clipboard

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

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

Link copied to clipboard
val datapointsToAlarm: 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: 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

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

Link copied to clipboard

The alarm states that trigger a notification.

Link copied to clipboard
val state: String? = null

The current state of the alarm.

Link copied to clipboard
val threshold: Double? = null

The value against which the specified statistic is compared.

Link copied to clipboard

Sets how this alarm will handle missing data points.