AWS::Lightsail::Alarm - AWS CloudFormation
SyntaxPropertiesReturn valuesRemarks

AWS::Lightsail::Alarm

The AWS::Lightsail::Alarm resource specifies an alarm that can be used to monitor a single metric for one of your Lightsail resources.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Lightsail::Alarm",
  "Properties" : {
      "AlarmName" : String,
      "ComparisonOperator" : String,
      "ContactProtocols" : [ String, ... ],
      "DatapointsToAlarm" : Integer,
      "EvaluationPeriods" : Integer,
      "MetricName" : String,
      "MonitoredResourceName" : String,
      "NotificationEnabled" : Boolean,
      "NotificationTriggers" : [ String, ... ],
      "Threshold" : Number,
      "TreatMissingData" : String
    }
}

YAML

Type: AWS::Lightsail::Alarm
Properties:
  AlarmName: String
  ComparisonOperator: String
  ContactProtocols: 
    - String
  DatapointsToAlarm: Integer
  EvaluationPeriods: Integer
  MetricName: String
  MonitoredResourceName: String
  NotificationEnabled: Boolean
  NotificationTriggers: 
    - String
  Threshold: Number
  TreatMissingData: String

Properties

AlarmName

The name of the alarm.

Required: Yes

Type: String

Pattern: \w[\w\-]*\w

Update requires: Replacement

ComparisonOperator

The arithmetic operation to use when comparing the specified statistic and threshold.

Required: Yes

Type: String

Allowed values: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold

Update requires: No interruption

ContactProtocols

The contact protocols for the alarm, such as Email, SMS (text messaging), or both.

Allowed Values: Email | SMS

Required: No

Type: Array of String

Update requires: No interruption

DatapointsToAlarm

The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM state.

Required: No

Type: Integer

Update requires: No interruption

EvaluationPeriods

The number of periods over which data is compared to the specified threshold.

Required: Yes

Type: Integer

Update requires: No interruption

MetricName

The name of the metric associated with the alarm.

Required: Yes

Type: String

Allowed values: CPUUtilization | NetworkIn | NetworkOut | StatusCheckFailed | StatusCheckFailed_Instance | StatusCheckFailed_System | ClientTLSNegotiationErrorCount | HealthyHostCount | UnhealthyHostCount | HTTPCode_LB_4XX_Count | HTTPCode_LB_5XX_Count | HTTPCode_Instance_2XX_Count | HTTPCode_Instance_3XX_Count | HTTPCode_Instance_4XX_Count | HTTPCode_Instance_5XX_Count | InstanceResponseTime | RejectedConnectionCount | RequestCount | DatabaseConnections | DiskQueueDepth | FreeStorageSpace | NetworkReceiveThroughput | NetworkTransmitThroughput | BurstCapacityTime | BurstCapacityPercentage

Update requires: Updates are not supported.

MonitoredResourceName

The name of the Lightsail resource that the alarm monitors.

Required: Yes

Type: String

Update requires: Updates are not supported.

NotificationEnabled

A Boolean value indicating whether the alarm is enabled.

Required: No

Type: Boolean

Update requires: No interruption

NotificationTriggers

The alarm states that trigger a notification.

Note

To specify the OK and INSUFFICIENT_DATA values, you must also specify ContactProtocols values. Otherwise, the OK and INSUFFICIENT_DATA values will not take effect and the stack will drift.

Allowed Values: OK | ALARM | INSUFFICIENT_DATA

Required: No

Type: Array of String

Update requires: No interruption

Threshold

The value against which the specified statistic is compared.

Required: Yes

Type: Number

Update requires: No interruption

TreatMissingData

Specifies how the alarm handles missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assumes the missing data is not within the threshold. Missing data counts towards the number of times that the metric is not within the threshold.

  • notBreaching - Assumes the missing data is within the threshold. Missing data does not count towards the number of times that the metric is not within the threshold.

  • ignore - Ignores the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

Required: No

Type: String

Allowed values: breaching | notBreaching | ignore | missing

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a unique identifier for this resource.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AlarmArn

The Amazon Resource Name (ARN) of the alarm.

State

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 recently 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.

Remarks

Notification triggers

To specify the OK and INSUFFICIENT_DATA values of the NotificationTriggers parameter, you must also specify ContactProtocols values. Otherwise, the OK and INSUFFICIENT_DATA values of the NotificationTriggers parameter will not take effect and the stack will drift.