software.amazon.awscdk.services.cloudwatch

Interface AlarmProps

All Superinterfaces:

CreateAlarmOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AlarmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:04.182Z")
 @Stability(value=Experimental)
public interface AlarmProps
extends software.amazon.jsii.JsiiSerializable, CreateAlarmOptions

(experimental) Properties for Alarms.

Example:

 import software.amazon.awscdk.core.*;
 DeliveryStream deliveryStream;
 // Alarm that triggers when the per-second average of incoming bytes exceeds 90% of the current service limit
 MathExpression incomingBytesPercentOfLimit = MathExpression.Builder.create()
         .expression("incomingBytes / 300 / bytePerSecLimit")
         .usingMetrics(Map.of(
                 "incomingBytes", deliveryStream.metricIncomingBytes(MetricOptions.builder().statistic(Statistic.SUM).build()),
                 "bytePerSecLimit", deliveryStream.metric("BytesPerSecondLimit")))
         .build();
 Alarm.Builder.create(this, "Alarm")
         .metric(incomingBytesPercentOfLimit)
         .threshold(0.9)
         .evaluationPeriods(3)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AlarmProps.Builder	builder()
IMetric	getMetric() (experimental) The metric to add the alarm on.

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.CreateAlarmOptions

getActionsEnabled, getAlarmDescription, getAlarmName, getComparisonOperator, getDatapointsToAlarm, getEvaluateLowSampleCountPercentile, getEvaluationPeriods, getPeriod, getStatistic, getThreshold, getTreatMissingData

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetric

@Stability(value=Experimental)
 @NotNull
IMetric getMetric()

(experimental) The metric to add the alarm on.

Metric objects can be obtained from most resources, or you can construct custom Metric objects by instantiating one.

builder

@Stability(value=Experimental)
static AlarmProps.Builder builder()

Specified by:

builder in interface CreateAlarmOptions

Returns:

a AlarmProps.Builder of AlarmProps