alarms

Creates, updates, deletes or gets an alarm resource or lists alarms in a region

Overview

Name	alarms
Type	Resource
Description	Resource Type definition for AWS::Lightsail::Alarm
Id	aws.lightsail.alarms

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
create_resource	INSERT	AlarmName, MonitoredResourceName, MetricName, ComparisonOperator, EvaluationPeriods, Threshold, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all alarms in a region.

SELECT
region,
alarm_name,
monitored_resource_name,
metric_name,
comparison_operator,
contact_protocols,
alarm_arn,
datapoints_to_alarm,
evaluation_periods,
notification_enabled,
notification_triggers,
threshold,
treat_missing_data,
state
FROM aws.lightsail.alarms
WHERE region = 'us-east-1';

Gets all properties from an individual alarm.

SELECT
region,
alarm_name,
monitored_resource_name,
metric_name,
comparison_operator,
contact_protocols,
alarm_arn,
datapoints_to_alarm,
evaluation_periods,
notification_enabled,
notification_triggers,
threshold,
treat_missing_data,
state
FROM aws.lightsail.alarms
WHERE region = 'us-east-1' AND data__Identifier = '<AlarmName>';

INSERT example

Use the following StackQL query and manifest file to create a new alarm resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.lightsail.alarms (
 AlarmName,
 MonitoredResourceName,
 MetricName,
 ComparisonOperator,
 EvaluationPeriods,
 Threshold,
 region
)
SELECT 
'{{ AlarmName }}',
 '{{ MonitoredResourceName }}',
 '{{ MetricName }}',
 '{{ ComparisonOperator }}',
 '{{ EvaluationPeriods }}',
 '{{ Threshold }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.lightsail.alarms (
 AlarmName,
 MonitoredResourceName,
 MetricName,
 ComparisonOperator,
 ContactProtocols,
 DatapointsToAlarm,
 EvaluationPeriods,
 NotificationEnabled,
 NotificationTriggers,
 Threshold,
 TreatMissingData,
 region
)
SELECT 
 '{{ AlarmName }}',
 '{{ MonitoredResourceName }}',
 '{{ MetricName }}',
 '{{ ComparisonOperator }}',
 '{{ ContactProtocols }}',
 '{{ DatapointsToAlarm }}',
 '{{ EvaluationPeriods }}',
 '{{ NotificationEnabled }}',
 '{{ NotificationTriggers }}',
 '{{ Threshold }}',
 '{{ TreatMissingData }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: alarm
    props:
      - name: AlarmName
        value: '{{ AlarmName }}'
      - name: MonitoredResourceName
        value: '{{ MonitoredResourceName }}'
      - name: MetricName
        value: '{{ MetricName }}'
      - name: ComparisonOperator
        value: '{{ ComparisonOperator }}'
      - name: ContactProtocols
        value:
          - '{{ ContactProtocols[0] }}'
      - name: DatapointsToAlarm
        value: '{{ DatapointsToAlarm }}'
      - name: EvaluationPeriods
        value: '{{ EvaluationPeriods }}'
      - name: NotificationEnabled
        value: '{{ NotificationEnabled }}'
      - name: NotificationTriggers
        value:
          - '{{ NotificationTriggers[0] }}'
      - name: Threshold
        value: null
      - name: TreatMissingData
        value: '{{ TreatMissingData }}'

DELETE example

/*+ delete */
DELETE FROM aws.lightsail.alarms
WHERE data__Identifier = '<AlarmName>'
AND region = 'us-east-1';

Permissions

To operate on the alarms resource, the following permissions are required:

Create

lightsail:PutAlarm,
lightsail:GetAlarms

Read

lightsail:GetAlarms

Update

lightsail:PutAlarm,
lightsail:GetAlarms

Delete

lightsail:DeleteAlarm,
lightsail:GetAlarms

List

lightsail:GetAlarms