Package software.amazon.awscdk.services.lightsail

Interface CfnAlarmProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.452Z")
@Stability(Stable)
public interface CfnAlarmProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAlarm.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lightsail.*;
 CfnAlarmProps cfnAlarmProps = CfnAlarmProps.builder()
         .alarmName("alarmName")
         .comparisonOperator("comparisonOperator")
         .evaluationPeriods(123)
         .metricName("metricName")
         .monitoredResourceName("monitoredResourceName")
         .threshold(123)
         // the properties below are optional
         .contactProtocols(List.of("contactProtocols"))
         .datapointsToAlarm(123)
         .notificationEnabled(false)
         .notificationTriggers(List.of("notificationTriggers"))
         .treatMissingData("treatMissingData")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAlarmProps.Builder	A builder for CfnAlarmProps
static final class	CfnAlarmProps.Jsii$Proxy	An implementation for CfnAlarmProps

Method Summary

Modifier and Type	Method	Description
static CfnAlarmProps.Builder	builder()
String	getAlarmName()	The name of the alarm.
String	getComparisonOperator()	The arithmetic operation to use when comparing the specified statistic and threshold.
default List<String>	getContactProtocols()	The contact protocols for the alarm, such as Email , SMS (text messaging), or both.
default Number	getDatapointsToAlarm()	The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM state.
Number	getEvaluationPeriods()	The number of periods over which data is compared to the specified threshold.
String	getMetricName()	The name of the metric associated with the alarm.
String	getMonitoredResourceName()	The name of the Lightsail resource that the alarm monitors.
default Object	getNotificationEnabled()	A Boolean value indicating whether the alarm is enabled.
default List<String>	getNotificationTriggers()	The alarm states that trigger a notification.
Number	getThreshold()	The value against which the specified statistic is compared.
default String	getTreatMissingData()	Specifies how the alarm handles missing data points.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarmName

@Stability(Stable)
@NotNull
String getAlarmName()

The name of the alarm.

See Also:

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

getComparisonOperator

@Stability(Stable)
@NotNull
String getComparisonOperator()

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

getEvaluationPeriods

@Stability(Stable)
@NotNull
Number getEvaluationPeriods()

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

getMetricName

@Stability(Stable)
@NotNull
String getMetricName()

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

getMonitoredResourceName

@Stability(Stable)
@NotNull
String getMonitoredResourceName()

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

getThreshold

@Stability(Stable)
@NotNull
Number getThreshold()

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

getContactProtocols

@Stability(Stable)
@Nullable
default List<String> getContactProtocols()

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

getDatapointsToAlarm

@Stability(Stable)
@Nullable
default Number getDatapointsToAlarm()

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

getNotificationEnabled

@Stability(Stable)
@Nullable
default Object getNotificationEnabled()

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

getNotificationTriggers

@Stability(Stable)
@Nullable
default List<String> getNotificationTriggers()

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

getTreatMissingData

@Stability(Stable)
@Nullable
default String getTreatMissingData()

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

builder

@Stability(Stable)
static CfnAlarmProps.Builder builder()

Returns:

a CfnAlarmProps.Builder of CfnAlarmProps