aws_lightsail_alarm

account_id

Type: STRING

arn

Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN) of the alarm.

comparison_operator

Type: STRING
Provider name: comparisonOperator
Description: The arithmetic operation used when comparing the specified statistic and threshold.

contact_protocols

Type: UNORDERED_LIST_STRING
Provider name: contactProtocols
Description: The contact protocols for the alarm, such as Email, SMS (text messaging), or both.

created_at

Type: TIMESTAMP
Provider name: createdAt
Description: The timestamp when the alarm was created.

datapoints_to_alarm

Type: INT32
Provider name: datapointsToAlarm
Description: The number of data points that must not within the specified threshold to trigger the alarm.

evaluation_periods

Type: INT32
Provider name: evaluationPeriods
Description: The number of periods over which data is compared to the specified threshold.

location

Type: STRUCT
Provider name: location
Description: An object that lists information about the location of the alarm.

• availability_zone
  Type: STRING
  Provider name: availabilityZone
  Description: The Availability Zone. Follows the format us-east-2a (case-sensitive).
  
• region_name
  Type: STRING
  Provider name: regionName
  Description: The Amazon Web Services Region name.
  

metric_name

Type: STRING
Provider name: metricName
Description: The name of the metric associated with the alarm.

monitored_resource_info

Type: STRUCT
Provider name: monitoredResourceInfo
Description: An object that lists information about the resource monitored by the alarm.

• arn
  Type: STRING
  Provider name: arn
  Description: The Amazon Resource Name (ARN) of the resource being monitored.
  
• name
  Type: STRING
  Provider name: name
  Description: The name of the Lightsail resource being monitored.
  
• resource_type
  Type: STRING
  Provider name: resourceType
  Description: The Lightsail resource type of the resource being monitored. Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
  

name

Type: STRING
Provider name: name
Description: The name of the alarm.

notification_enabled

Type: BOOLEAN
Provider name: notificationEnabled
Description: Indicates whether the alarm is enabled.

notification_triggers

Type: UNORDERED_LIST_STRING
Provider name: notificationTriggers
Description: The alarm states that trigger a notification.

period

Type: INT32
Provider name: period
Description: The period, in seconds, over which the statistic is applied.

resource_type

Type: STRING
Provider name: resourceType
Description: The Lightsail resource type of the alarm.

state

Type: STRING
Provider name: state
Description: 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

Type: STRING
Provider name: statistic
Description: 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

Type: STRING
Provider name: supportCode
Description: 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

Type: UNORDERED_LIST_STRING

threshold

Type: DOUBLE
Provider name: threshold
Description: The value against which the specified statistic is compared.

treat_missing_data

Type: STRING
Provider name: treatMissingData
Description: 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

Type: STRING
Provider name: unit
Description: The unit of the metric associated with the alarm.