Alarm

class Alarm

Describes an alarm.

An alarm is a way to monitor your Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String?

The Amazon Resource Name (ARN) of the alarm.

Link copied to clipboard

The arithmetic operation used when comparing the specified statistic and threshold.

Link copied to clipboard

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

Link copied to clipboard

The timestamp when the alarm was created.

Link copied to clipboard

The number of data points that must not within the specified threshold to trigger the alarm.

Link copied to clipboard

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

Link copied to clipboard

An object that lists information about the location of the alarm.

Link copied to clipboard

The name of the metric associated with the alarm.

Link copied to clipboard

An object that lists information about the resource monitored by the alarm.

Link copied to clipboard
val name: String?

The name of the alarm.

Link copied to clipboard

Indicates whether the alarm is enabled.

Link copied to clipboard

The alarm states that trigger a notification.

Link copied to clipboard
val period: Int?

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

Link copied to clipboard

The Lightsail resource type of the alarm.

Link copied to clipboard

The current state of the alarm.

Link copied to clipboard

The statistic for the metric associated with the alarm.

Link copied to clipboard

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

Link copied to clipboard

The value against which the specified statistic is compared.

Link copied to clipboard

Specifies how the alarm handles missing data points.

Link copied to clipboard

The unit of the metric associated with the alarm.

Functions

Link copied to clipboard
inline fun copy(block: Alarm.Builder.() -> Unit = {}): Alarm
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String