@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
date="2022-06-22T23:27:51.570Z")
public interface CfnAlarmProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnAlarmProps.Builder
A builder for
CfnAlarmProps |
static class |
CfnAlarmProps.Jsii$Proxy
An implementation for
CfnAlarmProps |
Modifier and Type | Method and Description |
---|---|
static CfnAlarmProps.Builder |
builder() |
java.lang.String |
getAlarmName()
The name of the alarm.
|
java.lang.String |
getComparisonOperator()
The arithmetic operation to use when comparing the specified statistic and threshold.
|
default java.util.List<java.lang.String> |
getContactProtocols()
The contact protocols for the alarm, such as `Email` , `SMS` (text messaging), or both.
|
default java.lang.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.
|
java.lang.Number |
getEvaluationPeriods()
The number of periods over which data is compared to the specified threshold.
|
java.lang.String |
getMetricName()
The name of the metric associated with the alarm.
|
java.lang.String |
getMonitoredResourceName()
The name of the Lightsail resource that the alarm monitors.
|
default java.lang.Object |
getNotificationEnabled()
A Boolean value indicating whether the alarm is enabled.
|
default java.util.List<java.lang.String> |
getNotificationTriggers()
The alarm states that trigger a notification.
|
java.lang.Number |
getThreshold()
The value against which the specified statistic is compared.
|
default java.lang.String |
getTreatMissingData()
Specifies how the alarm handles missing data points.
|
java.lang.String getAlarmName()
java.lang.String getComparisonOperator()
java.lang.Number getEvaluationPeriods()
java.lang.String getMetricName()
java.lang.String getMonitoredResourceName()
java.lang.Number getThreshold()
default java.util.List<java.lang.String> getContactProtocols()
Allowed Values : Email
| SMS
default java.lang.Number getDatapointsToAlarm()
default java.lang.Object getNotificationEnabled()
default java.util.List<java.lang.String> getNotificationTriggers()
To specify the
OK
andINSUFFICIENT_DATA
values, you must also specifyContactProtocols
values. Otherwise, theOK
andINSUFFICIENT_DATA
values will not take effect and the stack will drift.
Allowed Values : OK
| ALARM
| INSUFFICIENT_DATA
default java.lang.String getTreatMissingData()
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.static CfnAlarmProps.Builder builder()
CfnAlarmProps.Builder
of CfnAlarmProps