software.amazon.awscdk.services.cloudwatch

Interface CfnAlarmProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.217Z")
 @Stability(value=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.cloudwatch.*;
 CfnAlarmProps cfnAlarmProps = CfnAlarmProps.builder()
         .comparisonOperator("comparisonOperator")
         .evaluationPeriods(123)
         // the properties below are optional
         .actionsEnabled(false)
         .alarmActions(List.of("alarmActions"))
         .alarmDescription("alarmDescription")
         .alarmName("alarmName")
         .datapointsToAlarm(123)
         .dimensions(List.of(DimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .evaluateLowSampleCountPercentile("evaluateLowSampleCountPercentile")
         .extendedStatistic("extendedStatistic")
         .insufficientDataActions(List.of("insufficientDataActions"))
         .metricName("metricName")
         .metrics(List.of(MetricDataQueryProperty.builder()
                 .id("id")
                 // the properties below are optional
                 .accountId("accountId")
                 .expression("expression")
                 .label("label")
                 .metricStat(MetricStatProperty.builder()
                         .metric(MetricProperty.builder()
                                 .dimensions(List.of(DimensionProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .metricName("metricName")
                                 .namespace("namespace")
                                 .build())
                         .period(123)
                         .stat("stat")
                         // the properties below are optional
                         .unit("unit")
                         .build())
                 .period(123)
                 .returnData(false)
                 .build()))
         .namespace("namespace")
         .okActions(List.of("okActions"))
         .period(123)
         .statistic("statistic")
         .threshold(123)
         .thresholdMetricId("thresholdMetricId")
         .treatMissingData("treatMissingData")
         .unit("unit")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnAlarmProps.Builder	builder()
default Object	getActionsEnabled() Indicates whether actions should be executed during any changes to the alarm state.
default List<String>	getAlarmActions() The list of actions to execute when this alarm transitions into an ALARM state from any other state.
default String	getAlarmDescription() The description of the alarm.
default String	getAlarmName() The name of the alarm.
String	getComparisonOperator() The arithmetic operation to use when comparing the specified statistic and threshold.
default Number	getDatapointsToAlarm() The number of datapoints that must be breaching to trigger the alarm.
default Object	getDimensions() The dimensions for the metric associated with the alarm.
default String	getEvaluateLowSampleCountPercentile() Used only for alarms based on percentiles.
Number	getEvaluationPeriods() The number of periods over which data is compared to the specified threshold.
default String	getExtendedStatistic() The percentile statistic for the metric associated with the alarm.
default List<String>	getInsufficientDataActions() The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
default String	getMetricName() The name of the metric associated with the alarm.
default Object	getMetrics() An array that enables you to create an alarm based on the result of a metric math expression.
default String	getNamespace() The namespace of the metric associated with the alarm.
default List<String>	getOkActions() The actions to execute when this alarm transitions to the `OK` state from any other state.
default Number	getPeriod() The period, in seconds, over which the statistic is applied.
default String	getStatistic() The statistic for the metric associated with the alarm, other than percentile.
default Number	getThreshold() The value to compare with the specified statistic.
default String	getThresholdMetricId() In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.
default String	getTreatMissingData() Sets how this alarm is to handle missing data points.
default String	getUnit() The unit of the metric associated with the alarm.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getComparisonOperator

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

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

The specified statistic value is used as the first operand.

You can specify the following values: GreaterThanThreshold , GreaterThanOrEqualToThreshold , LessThanThreshold , or LessThanOrEqualToThreshold .

getEvaluationPeriods

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

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

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.

For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .

getActionsEnabled

@Stability(value=Stable)
 @Nullable
default Object getActionsEnabled()

Indicates whether actions should be executed during any changes to the alarm state.

The default is TRUE.

getAlarmActions

@Stability(value=Stable)
 @Nullable
default List<String> getAlarmActions()

The list of actions to execute when this alarm transitions into an ALARM state from any other state.

Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutMetricAlarm in the Amazon CloudWatch API Reference .

getAlarmDescription

@Stability(value=Stable)
 @Nullable
default String getAlarmDescription()

The description of the alarm.

getAlarmName

@Stability(value=Stable)
 @Nullable
default String getAlarmName()

The name of the alarm.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

getDatapointsToAlarm

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

The number of datapoints that must be breaching to trigger the alarm.

This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for EvaluationPeriods is the N value. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .

If you omit this parameter, CloudWatch uses the same value here that you set for EvaluationPeriods , and the alarm goes to alarm state if that many consecutive periods are breaching.

getDimensions

@Stability(value=Stable)
 @Nullable
default Object getDimensions()

The dimensions for the metric associated with the alarm.

For an alarm based on a math expression, you can't specify Dimensions . Instead, you use Metrics .

getEvaluateLowSampleCountPercentile

@Stability(value=Stable)
 @Nullable
default String getEvaluateLowSampleCountPercentile()

Used only for alarms based on percentiles.

If ignore , the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

getExtendedStatistic

@Stability(value=Stable)
 @Nullable
default String getExtendedStatistic()

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

For an alarm based on a math expression, you can't specify ExtendedStatistic . Instead, you use Metrics .

getInsufficientDataActions

@Stability(value=Stable)
 @Nullable
default List<String> getInsufficientDataActions()

The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.

Each action is specified as an Amazon Resource Name (ARN).

getMetricName

@Stability(value=Stable)
 @Nullable
default String getMetricName()

The name of the metric associated with the alarm.

This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName .

getMetrics

@Stability(value=Stable)
 @Nullable
default Object getMetrics()

An array that enables you to create an alarm based on the result of a metric math expression.

Each item in the array either retrieves a metric or performs a math expression.

If you specify the Metrics parameter, you cannot specify MetricName , Dimensions , Period , Namespace , Statistic , ExtendedStatistic , or Unit .

getNamespace

@Stability(value=Stable)
 @Nullable
default String getNamespace()

The namespace of the metric associated with the alarm.

This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

For a list of namespaces for metrics from AWS services, see AWS Services That Publish CloudWatch Metrics.

getOkActions

@Stability(value=Stable)
 @Nullable
default List<String> getOkActions()

The actions to execute when this alarm transitions to the `OK` state from any other state.

Each action is specified as an Amazon Resource Name (ARN).

getPeriod

@Stability(value=Stable)
 @Nullable
default Number getPeriod()

The period, in seconds, over which the statistic is applied.

This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.

For an alarm based on a math expression, you can't specify Period , and instead you use the Metrics parameter.

Minimum: 10

getStatistic

@Stability(value=Stable)
 @Nullable
default String getStatistic()

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use `ExtendedStatistic` .

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

For an alarm based on a math expression, you can't specify Statistic . Instead, you use Metrics .

getThreshold

@Stability(value=Stable)
 @Nullable
default Number getThreshold()

The value to compare with the specified statistic.

getThresholdMetricId

@Stability(value=Stable)
 @Nullable
default String getThresholdMetricId()

In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.

getTreatMissingData

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

Sets how this alarm is to handle missing data points.

Valid values are breaching , notBreaching , ignore , and missing . For more information, see Configuring How CloudWatch Alarms Treat Missing Data in the Amazon CloudWatch User Guide .

If you omit this parameter, the default behavior of missing is used.

getUnit

@Stability(value=Stable)
 @Nullable
default String getUnit()

The unit of the metric associated with the alarm.

Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.

You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.

builder

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

Returns:

a CfnAlarmProps.Builder of CfnAlarmProps