class Aws::Lightsail::Types::Alarm

Describes an alarm.

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

[1]: lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms

@!attribute [rw] name

The name of the alarm.
@return [String]

@!attribute [rw] arn

The Amazon Resource Name (ARN) of the alarm.
@return [String]

@!attribute [rw] created_at

The timestamp when the alarm was created.
@return [Time]

@!attribute [rw] location

An object that lists information about the location of the alarm.
@return [Types::ResourceLocation]

@!attribute [rw] resource_type

The Lightsail resource type (e.g., `Alarm`).
@return [String]

@!attribute [rw] support_code

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.
@return [String]

@!attribute [rw] monitored_resource_info

An object that lists information about the resource monitored by the
alarm.
@return [Types::MonitoredResourceInfo]

@!attribute [rw] comparison_operator

The arithmetic operation used when comparing the specified statistic
and threshold.
@return [String]

@!attribute [rw] evaluation_periods

The number of periods over which data is compared to the specified
threshold.
@return [Integer]

@!attribute [rw] period

The period, in seconds, over which the statistic is applied.
@return [Integer]

@!attribute [rw] threshold

The value against which the specified statistic is compared.
@return [Float]

@!attribute [rw] datapoints_to_alarm

The number of data points that must not within the specified
threshold to trigger the alarm.
@return [Integer]

@!attribute [rw] treat_missing_data

Specifies how the alarm handles missing data points.

An alarm can treat missing data in the following ways:

* `breaching` - Assume the missing data is not within the threshold.
  Missing data counts towards the number of times the metric is not
  within the threshold.

* `notBreaching` - Assume the missing data is within the threshold.
  Missing data does not count towards the number of times the metric
  is not within the threshold.

* `ignore` - Ignore the missing data. Maintains the current alarm
  state.

* `missing` - Missing data is treated as missing.
@return [String]

@!attribute [rw] statistic

The statistic for the metric associated with the alarm.

The following statistics are available:

* `Minimum` - The lowest value observed during the specified period.
  Use this value to determine low volumes of activity for your
  application.

* `Maximum` - The highest value observed during the specified
  period. Use this value to determine high volumes of activity for
  your application.

* `Sum` - All values submitted for the matching metric added
  together. You can use this statistic to determine the total volume
  of a metric.

* `Average` - The value of Sum / SampleCount during the specified
  period. By comparing this statistic with the Minimum and Maximum
  values, you can determine the full scope of a metric and how close
  the average use is to the Minimum and Maximum values. This
  comparison helps you to know when to increase or decrease your
  resources.

* `SampleCount` - The count, or number, of data points used for the
  statistical calculation.
@return [String]

@!attribute [rw] metric_name

The name of the metric associated with the alarm.
@return [String]

@!attribute [rw] state

The current state of the alarm.

An alarm has the following possible states:

* `ALARM` - The metric is outside of the defined threshold.

* `INSUFFICIENT_DATA` - The alarm has just started, the metric is
  not available, or not enough data is available for the metric to
  determine the alarm state.

* `OK` - The metric is within the defined threshold.
@return [String]

@!attribute [rw] unit

The unit of the metric associated with the alarm.
@return [String]

@!attribute [rw] contact_protocols

The contact protocols for the alarm, such as `Email`, `SMS` (text
messaging), or both.
@return [Array<String>]

@!attribute [rw] notification_triggers

The alarm states that trigger a notification.
@return [Array<String>]

@!attribute [rw] notification_enabled

Indicates whether the alarm is enabled.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Alarm AWS API Documentation

Constants

SENSITIVE