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	awscc.lightsail.alarms

Fields

get (all properties)

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 name of the Lightsail resource that the alarm monitors.
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.

list (identifiers only)

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.
region	string	AWS region.

For more information, see AWS::Lightsail::Alarm.

Methods

Name	Resource	Accessible by	Required Params
create_resource	alarms	INSERT	AlarmName, MonitoredResourceName, MetricName, ComparisonOperator, EvaluationPeriods, Threshold, region
delete_resource	alarms	DELETE	Identifier, region
update_resource	alarms	UPDATE	Identifier, PatchDocument, region
list_resources	alarms_list_only	SELECT	region
get_resource	alarms	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.lightsail.alarms
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ alarm_name }}';

list (identifiers only)

Lists all alarms in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.lightsail.alarms (
  AlarmName,
  MonitoredResourceName,
  MetricName,
  ComparisonOperator,
  EvaluationPeriods,
  Threshold,
  region
)
SELECT
  '{{ alarm_name }}',
  '{{ monitored_resource_name }}',
  '{{ metric_name }}',
  '{{ comparison_operator }}',
  '{{ evaluation_periods }}',
  '{{ threshold }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.lightsail.alarms (
  AlarmName,
  MonitoredResourceName,
  MetricName,
  ComparisonOperator,
  ContactProtocols,
  DatapointsToAlarm,
  EvaluationPeriods,
  NotificationEnabled,
  NotificationTriggers,
  Threshold,
  TreatMissingData,
  region
)
SELECT
  '{{ alarm_name }}',
  '{{ monitored_resource_name }}',
  '{{ metric_name }}',
  '{{ comparison_operator }}',
  '{{ contact_protocols }}',
  '{{ datapoints_to_alarm }}',
  '{{ evaluation_periods }}',
  '{{ notification_enabled }}',
  '{{ notification_triggers }}',
  '{{ threshold }}',
  '{{ treat_missing_data }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: alarm
    props:
      - name: alarm_name
        value: '{{ alarm_name }}'
      - name: monitored_resource_name
        value: '{{ monitored_resource_name }}'
      - name: metric_name
        value: '{{ metric_name }}'
      - name: comparison_operator
        value: '{{ comparison_operator }}'
      - name: contact_protocols
        value:
          - '{{ contact_protocols[0] }}'
      - name: datapoints_to_alarm
        value: '{{ datapoints_to_alarm }}'
      - name: evaluation_periods
        value: '{{ evaluation_periods }}'
      - name: notification_enabled
        value: '{{ notification_enabled }}'
      - name: notification_triggers
        value:
          - '{{ notification_triggers[0] }}'
      - name: threshold
        value: null
      - name: treat_missing_data
        value: '{{ treat_missing_data }}'

UPDATE example

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

/*+ update */
UPDATE awscc.lightsail.alarms
SET PatchDocument = string('{{ {
    "ComparisonOperator": comparison_operator,
    "ContactProtocols": contact_protocols,
    "DatapointsToAlarm": datapoints_to_alarm,
    "EvaluationPeriods": evaluation_periods,
    "NotificationEnabled": notification_enabled,
    "NotificationTriggers": notification_triggers,
    "Threshold": threshold,
    "TreatMissingData": treat_missing_data
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ alarm_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.lightsail.alarms
WHERE
  Identifier = '{{ alarm_name }}' 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