alarms_list_only
Lists alarms
in a region or regions, for all properties use alarms
Overview
Name | alarms_list_only |
Type | Resource |
Description | Resource Type definition for AWS::Lightsail::Alarm |
Id | aws.lightsail.alarms_list_only |
Fields
Name | Datatype | Description |
---|---|---|
alarm_name | string | The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm. |
monitored_resource_name | string | The validation status of the SSL/TLS certificate. |
metric_name | string | The name of the metric to associate with the alarm. |
comparison_operator | string | The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand. |
contact_protocols | array | The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both. |
alarm_arn | string | |
datapoints_to_alarm | integer | 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. |
evaluation_periods | integer | 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. |
notification_enabled | boolean | Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter. |
notification_triggers | array | The alarm states that trigger a notification. |
threshold | number | The value against which the specified statistic is compared. |
treat_missing_data | string | Sets how this alarm will handle missing data points. |
state | string | The current state of the alarm. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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