interface CfnAlarmProps

Language	Type name
.NET	Amazon.CDK.AWS.Lightsail.CfnAlarmProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslightsail#CfnAlarmProps
Java	software.amazon.awscdk.services.lightsail.CfnAlarmProps
Python	aws_cdk.aws_lightsail.CfnAlarmProps
TypeScript	aws-cdk-lib » aws_lightsail » CfnAlarmProps

Properties for defining a CfnAlarm.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lightsail as lightsail } from 'aws-cdk-lib';
const cfnAlarmProps: lightsail.CfnAlarmProps = {
  alarmName: 'alarmName',
  comparisonOperator: 'comparisonOperator',
  evaluationPeriods: 123,
  metricName: 'metricName',
  monitoredResourceName: 'monitoredResourceName',
  threshold: 123,

  // the properties below are optional
  contactProtocols: ['contactProtocols'],
  datapointsToAlarm: 123,
  notificationEnabled: false,
  notificationTriggers: ['notificationTriggers'],
  treatMissingData: 'treatMissingData',
};

Properties

Name	Type	Description
alarmName	string	The name of the alarm.
comparisonOperator	string	The arithmetic operation to use when comparing the specified statistic and threshold.
evaluationPeriods	number	The number of periods over which data is compared to the specified threshold.
metricName	string	The name of the metric associated with the alarm.
monitoredResourceName	string	The name of the Lightsail resource that the alarm monitors.
threshold	number	The value against which the specified statistic is compared.
contactProtocols?	string[]	The contact protocols for the alarm, such as Email , SMS (text messaging), or both.
datapointsToAlarm?	number	The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM state.
notificationEnabled?	boolean | IResolvable	A Boolean value indicating whether the alarm is enabled.
notificationTriggers?	string[]	The alarm states that trigger a notification.
treatMissingData?	string	Specifies how the alarm handles missing data points.

---

alarmName

Type: string

The name of the alarm.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-alarmname

---

comparisonOperator

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-comparisonoperator

---

evaluationPeriods

Type: number

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-evaluationperiods

---

metricName

Type: string

The name of the metric associated with the alarm.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-metricname

---

monitoredResourceName

Type: string

The name of the Lightsail resource that the alarm monitors.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-monitoredresourcename

---

threshold

Type: number

The value against which the specified statistic is compared.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-threshold

---

contactProtocols?

Type: string[] (optional)

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

Allowed Values : Email | SMS

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-contactprotocols

---

datapointsToAlarm?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-datapointstoalarm

---

notificationEnabled?

Type: boolean | IResolvable (optional)

A Boolean value indicating whether the alarm is enabled.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-notificationenabled

---

notificationTriggers?

Type: string[] (optional)

The alarm states that trigger a notification.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-notificationtriggers

---

treatMissingData?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-treatmissingdata