software.amazon.awscdk.services.cloudwatch

Interface AlarmProps

All Superinterfaces:

CreateAlarmOptions

All Known Implementing Classes:

AlarmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:53.457Z")
public interface AlarmProps
extends CreateAlarmOptions

Properties for Alarms.

Example:

 import software.amazon.awscdk.services.cloudwatch.*;
 Alias alias;
 // or add alarms to an existing group
 Alias blueGreenAlias;
 Alarm alarm = Alarm.Builder.create(this, "Errors")
         .comparisonOperator(ComparisonOperator.GREATER_THAN_THRESHOLD)
         .threshold(1)
         .evaluationPeriods(1)
         .metric(alias.metricErrors())
         .build();
 LambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.Builder.create(this, "BlueGreenDeployment")
         .alias(alias)
         .deploymentConfig(LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE)
         .alarms(List.of(alarm))
         .build();
 deploymentGroup.addAlarm(Alarm.Builder.create(this, "BlueGreenErrors")
         .comparisonOperator(ComparisonOperator.GREATER_THAN_THRESHOLD)
         .threshold(1)
         .evaluationPeriods(1)
         .metric(blueGreenAlias.metricErrors())
         .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() 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

Method Detail

getMetric

IMetric getMetric()

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

static AlarmProps.Builder builder()

Specified by:

builder in interface CreateAlarmOptions

Returns:

a AlarmProps.Builder of AlarmProps