Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-lightsail-alarm.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::Lightsail::Alarm. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git

Properties

AlarmName string | Aws_CF_FunctionString required

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

MonitoredResourceName string | Aws_CF_FunctionString required

The validation status of the SSL/TLS certificate.

MetricName string | Aws_CF_FunctionString required

The name of the metric to associate with the alarm.

ComparisonOperator string | Aws_CF_FunctionString required

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

EvaluationPeriods integer required

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.

Threshold number required

The value against which the specified statistic is compared.

ContactProtocols string[]

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

uniqueItems=true
DatapointsToAlarm 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.

NotificationEnabled boolean

Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.

NotificationTriggers string[]

The alarm states that trigger a notification.

uniqueItems=true
TreatMissingData string | Aws_CF_FunctionString

Sets how this alarm will handle missing data points.