Skip to main content

alarms_list_only

Lists alarms in a region or regions, for all properties use alarms

Overview

Namealarms_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Alarm
Idaws.lightsail.alarms_list_only

Fields

NameDatatypeDescription
alarm_namestringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
monitored_resource_namestringThe validation status of the SSL/TLS certificate.
metric_namestringThe name of the metric to associate with the alarm.
comparison_operatorstringThe arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
contact_protocolsarrayThe contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
alarm_arnstring
datapoints_to_alarmintegerThe 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.
evaluation_periodsintegerThe 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.
notification_enabledbooleanIndicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
notification_triggersarrayThe alarm states that trigger a notification.
thresholdnumberThe value against which the specified statistic is compared.
treat_missing_datastringSets how this alarm will handle missing data points.
statestringThe current state of the alarm.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all alarms in a region.

SELECT
region,
alarm_name
FROM aws.lightsail.alarms_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the alarms_list_only resource, see alarms