aws-cdk-lib.aws_lightsail.CfnAlarmProps

CfnAlarmProps Struct

Properties for defining a CfnAlarm.

CfnAlarmProps

used as props by

• CfnAlarm

Source

Generated code

Type last changed

v2.9.0 · 26 Jan 2022

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

alarmNamestringalarm_namestralarmNameStringAlarmNamestringAlarmName*stringrequired#

The name of the alarm.

comparisonOperatorstringcomparison_operatorstrcomparisonOperatorStringComparisonOperatorstringComparisonOperator*stringrequired#

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

contactProtocols?optionalstring[]contact_protocols?optionaltyping.List[str]contactProtocols?optionalList<String>ContactProtocols?optionalstring[]ContactProtocols?optional*[]*string#

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

Allowed Values : Email | SMS

datapointsToAlarm?optionalnumberdatapoints_to_alarm?optionalint | floatdatapointsToAlarm?optionalNumberDatapointsToAlarm?optionaldoubleDatapointsToAlarm?optional*float64#

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

evaluationPeriodsnumberevaluation_periodsint | floatevaluationPeriodsNumberEvaluationPeriodsdoubleEvaluationPeriods*float64required#

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

metricNamestringmetric_namestrmetricNameStringMetricNamestringMetricName*stringrequired#

The name of the metric associated with the alarm.

monitoredResourceNamestringmonitored_resource_namestrmonitoredResourceNameStringMonitoredResourceNamestringMonitoredResourceName*stringrequired#

The name of the Lightsail resource that the alarm monitors.

notificationEnabled?optionalboolean | IResolvablenotification_enabled?optionaltyping.Union[bool, IResolvable]notificationEnabled?optionalBooleanNotificationEnabled?optionalboolNotificationEnabled?optionalinterface{}#

A Boolean value indicating whether the alarm is enabled.

notificationTriggers?optionalstring[]notification_triggers?optionaltyping.List[str]notificationTriggers?optionalList<String>NotificationTriggers?optionalstring[]NotificationTriggers?optional*[]*string#

The alarm states that trigger a notification.

notes

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

thresholdnumberthresholdint | floatthresholdNumberThresholddoubleThreshold*float64required#

The value against which the specified statistic is compared.

treatMissingData?optionalstringtreat_missing_data?optionalstrtreatMissingData?optionalStringTreatMissingData?optionalstringTreatMissingData?optional*string#

Specifies how the alarm handles missing data points.

notes

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.