software.amazon.awscdk.services.lightsail

Class CfnAlarm

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lightsail.CfnAlarm

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.628Z")
 @Stability(value=Stable)
public class CfnAlarm
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lightsail::Alarm`.

The AWS::Lightsail::Alarm resource specifies an alarm that can be used to monitor a single metric for one of your Lightsail resources.

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.*;
 CfnAlarm cfnAlarm = CfnAlarm.Builder.create(this, "MyCfnAlarm")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAlarm.Builder A fluent builder for CfnAlarm.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAlarm(software.constructs.Construct scope, String id, CfnAlarmProps props) Create a new `AWS::Lightsail::Alarm`.
protected	CfnAlarm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAlarm(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAlarmName() The name of the alarm.
String	getAttrAlarmArn() The Amazon Resource Name (ARN) of the alarm.
String	getAttrState() The current state of the alarm.
protected Map<String,Object>	getCfnProperties()
String	getComparisonOperator() The arithmetic operation to use when comparing the specified statistic and threshold.
List<String>	getContactProtocols() The contact protocols for the alarm, such as `Email` , `SMS` (text messaging), or both.
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.
Object	getNotificationEnabled() A Boolean value indicating whether the alarm is enabled.
List<String>	getNotificationTriggers() The alarm states that trigger a notification.
Number	getThreshold() The value against which the specified statistic is compared.
String	getTreatMissingData() Specifies how the alarm handles missing data points.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAlarmName(String value) The name of the alarm.
void	setComparisonOperator(String value) The arithmetic operation to use when comparing the specified statistic and threshold.
void	setContactProtocols(List<String> value) The contact protocols for the alarm, such as `Email` , `SMS` (text messaging), or both.
void	setDatapointsToAlarm(Number value) The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the `ALARM` state.
void	setEvaluationPeriods(Number value) The number of periods over which data is compared to the specified threshold.
void	setMetricName(String value) The name of the metric associated with the alarm.
void	setMonitoredResourceName(String value) The name of the Lightsail resource that the alarm monitors.
void	setNotificationEnabled(Boolean value) A Boolean value indicating whether the alarm is enabled.
void	setNotificationEnabled(IResolvable value) A Boolean value indicating whether the alarm is enabled.
void	setNotificationTriggers(List<String> value) The alarm states that trigger a notification.
void	setThreshold(Number value) The value against which the specified statistic is compared.
void	setTreatMissingData(String value) Specifies how the alarm handles missing data points.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAlarm

protected CfnAlarm(software.amazon.jsii.JsiiObjectRef objRef)

CfnAlarm

protected CfnAlarm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAlarm

@Stability(value=Stable)
public CfnAlarm(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnAlarmProps props)

Create a new `AWS::Lightsail::Alarm`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAlarmArn

@Stability(value=Stable)
 @NotNull
public String getAttrAlarmArn()

The Amazon Resource Name (ARN) of the alarm.

getAttrState

@Stability(value=Stable)
 @NotNull
public String getAttrState()

The current state of the alarm.

An alarm has the following possible states:

• ALARM - The metric is outside of the defined threshold.
• INSUFFICIENT_DATA - The alarm has recently started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
• OK - The metric is within the defined threshold.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAlarmName

@Stability(value=Stable)
 @NotNull
public String getAlarmName()

The name of the alarm.

setAlarmName

@Stability(value=Stable)
public void setAlarmName(@NotNull
                                                  String value)

The name of the alarm.

getComparisonOperator

@Stability(value=Stable)
 @NotNull
public String getComparisonOperator()

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

setComparisonOperator

@Stability(value=Stable)
public void setComparisonOperator(@NotNull
                                                           String value)

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

getEvaluationPeriods

@Stability(value=Stable)
 @NotNull
public Number getEvaluationPeriods()

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

setEvaluationPeriods

@Stability(value=Stable)
public void setEvaluationPeriods(@NotNull
                                                          Number value)

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

getMetricName

@Stability(value=Stable)
 @NotNull
public String getMetricName()

The name of the metric associated with the alarm.

setMetricName

@Stability(value=Stable)
public void setMetricName(@NotNull
                                                   String value)

The name of the metric associated with the alarm.

getMonitoredResourceName

@Stability(value=Stable)
 @NotNull
public String getMonitoredResourceName()

The name of the Lightsail resource that the alarm monitors.

setMonitoredResourceName

@Stability(value=Stable)
public void setMonitoredResourceName(@NotNull
                                                              String value)

The name of the Lightsail resource that the alarm monitors.

getThreshold

@Stability(value=Stable)
 @NotNull
public Number getThreshold()

The value against which the specified statistic is compared.

setThreshold

@Stability(value=Stable)
public void setThreshold(@NotNull
                                                  Number value)

The value against which the specified statistic is compared.

getContactProtocols

@Stability(value=Stable)
 @Nullable
public List<String> getContactProtocols()

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

Allowed Values : Email | SMS

setContactProtocols

@Stability(value=Stable)
public void setContactProtocols(@Nullable
                                                         List<String> value)

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

Allowed Values : Email | SMS

getDatapointsToAlarm

@Stability(value=Stable)
 @Nullable
public 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.

setDatapointsToAlarm

@Stability(value=Stable)
public void setDatapointsToAlarm(@Nullable
                                                          Number value)

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

getNotificationEnabled

@Stability(value=Stable)
 @Nullable
public Object getNotificationEnabled()

A Boolean value indicating whether the alarm is enabled.

setNotificationEnabled

@Stability(value=Stable)
public void setNotificationEnabled(@Nullable
                                                            Boolean value)

A Boolean value indicating whether the alarm is enabled.

setNotificationEnabled

@Stability(value=Stable)
public void setNotificationEnabled(@Nullable
                                                            IResolvable value)

A Boolean value indicating whether the alarm is enabled.

getNotificationTriggers

@Stability(value=Stable)
 @Nullable
public 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

setNotificationTriggers

@Stability(value=Stable)
public void setNotificationTriggers(@Nullable
                                                             List<String> value)

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

getTreatMissingData

@Stability(value=Stable)
 @Nullable
public 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.

setTreatMissingData

@Stability(value=Stable)
public void setTreatMissingData(@Nullable
                                                         String value)

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.