Lightsail Alarm

Docs > DDSQL Reference > Data Directory > Lightsail Alarm

Lightsail Alarm is a monitoring resource in Amazon Lightsail that lets you track the health and performance of your instances, databases, and other resources. It allows you to set thresholds on metrics such as CPU utilization, memory, or network activity, and automatically notifies you when those thresholds are breached. This helps you maintain application availability and respond quickly to performance issues.

aws.lightsail_alarm

Fields

ID	Type	Data Type	Description
_key	core	string
account_id	core	string
arn	core	string	The Amazon Resource Name (ARN) of the alarm.
comparison_operator	core	string	The arithmetic operation used when comparing the specified statistic and threshold.
contact_protocols	core	array<string>	The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
created_at	core	timestamp	The timestamp when the alarm was created.
datapoints_to_alarm	core	int64	The number of data points that must not within the specified threshold to trigger the alarm.
evaluation_periods	core	int64	The number of periods over which data is compared to the specified threshold.
location	core	json	An object that lists information about the location of the alarm.
metric_name	core	string	The name of the metric associated with the alarm.
monitored_resource_info	core	json	An object that lists information about the resource monitored by the alarm.
name	core	string	The name of the alarm.
notification_enabled	core	bool	Indicates whether the alarm is enabled.
notification_triggers	core	array<string>	The alarm states that trigger a notification.
period	core	int64	The period, in seconds, over which the statistic is applied.
resource_type	core	string	The Lightsail resource type of the alarm.
state	core	string	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.
statistic	core	string	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.
support_code	core	string	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.
tags	core	hstore
threshold	core	float64	The value against which the specified statistic is compared.
treat_missing_data	core	string	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.
unit	core	string	The unit of the metric associated with the alarm.