AWS Fundamentals Logo
AWS Fundamentals
AWS::Lightsail::Alarm

Lightsail Alarm

Resource Type definition for AWS::Lightsail::Alarm

Properties

11 configurable properties. 6 required. Click a row to see details.

Filter:
PropertyTypeFlags
AlarmName
string
RequiredCreate-only
ComparisonOperator
string
Required
EvaluationPeriods
integer
Required
MetricName
string
RequiredCreate-only
MonitoredResourceName
string
RequiredCreate-only
Threshold
number
Required
ContactProtocols
Array<string>
DatapointsToAlarm
integer
NotificationEnabled
boolean
NotificationTriggers
Array<string>
TreatMissingData
string

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
AlarmArnstring-
StatestringThe current state of the alarm.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Lightsail::Alarm

Resources:
  MyResource:
    Type: AWS::Lightsail::Alarm
    Properties:
      AlarmName: "my-alarmname"
      MonitoredResourceName: "my-monitoredresourcename"
      MetricName: "my-metricname"
      ComparisonOperator: "value"
      EvaluationPeriods: 1
      Threshold: 1

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

lightsail:PutAlarmlightsail:GetAlarms

read

lightsail:GetAlarms

update

lightsail:PutAlarmlightsail:GetAlarms

delete

lightsail:DeleteAlarmlightsail:GetAlarms

list

lightsail:GetAlarms

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceLightsail
Properties13
Required6
TaggingNot supported
Primary IDAlarmName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AlarmNameMonitoredResourceNameMetricName

Related Resources

External Links