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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.356Z")
 @Stability(value=Stable)
public interface CfnAlarmProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::CloudWatch::Alarm`.

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() `AWS::CloudWatch::Alarm.ActionsEnabled`.
default List<String>	getAlarmActions() `AWS::CloudWatch::Alarm.AlarmActions`.
default String	getAlarmDescription() `AWS::CloudWatch::Alarm.AlarmDescription`.
default String	getAlarmName() `AWS::CloudWatch::Alarm.AlarmName`.
String	getComparisonOperator() `AWS::CloudWatch::Alarm.ComparisonOperator`.
default Number	getDatapointsToAlarm() `AWS::CloudWatch::Alarm.DatapointsToAlarm`.
default Object	getDimensions() `AWS::CloudWatch::Alarm.Dimensions`.
default String	getEvaluateLowSampleCountPercentile() `AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile`.
Number	getEvaluationPeriods() `AWS::CloudWatch::Alarm.EvaluationPeriods`.
default String	getExtendedStatistic() `AWS::CloudWatch::Alarm.ExtendedStatistic`.
default List<String>	getInsufficientDataActions() `AWS::CloudWatch::Alarm.InsufficientDataActions`.
default String	getMetricName() `AWS::CloudWatch::Alarm.MetricName`.
default Object	getMetrics() `AWS::CloudWatch::Alarm.Metrics`.
default String	getNamespace() `AWS::CloudWatch::Alarm.Namespace`.
default List<String>	getOkActions() `AWS::CloudWatch::Alarm.OKActions`.
default Number	getPeriod() `AWS::CloudWatch::Alarm.Period`.
default String	getStatistic() `AWS::CloudWatch::Alarm.Statistic`.
default Number	getThreshold() `AWS::CloudWatch::Alarm.Threshold`.
default String	getThresholdMetricId() `AWS::CloudWatch::Alarm.ThresholdMetricId`.
default String	getTreatMissingData() `AWS::CloudWatch::Alarm.TreatMissingData`.
default String	getUnit() `AWS::CloudWatch::Alarm.Unit`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActionsEnabled

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

`AWS::CloudWatch::Alarm.ActionsEnabled`.

getAlarmActions

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

`AWS::CloudWatch::Alarm.AlarmActions`.

getAlarmDescription

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

`AWS::CloudWatch::Alarm.AlarmDescription`.

getAlarmName

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

`AWS::CloudWatch::Alarm.AlarmName`.

getComparisonOperator

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

`AWS::CloudWatch::Alarm.ComparisonOperator`.

getDatapointsToAlarm

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

`AWS::CloudWatch::Alarm.DatapointsToAlarm`.

getDimensions

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

`AWS::CloudWatch::Alarm.Dimensions`.

getEvaluateLowSampleCountPercentile

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

`AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile`.

getEvaluationPeriods

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

`AWS::CloudWatch::Alarm.EvaluationPeriods`.

getExtendedStatistic

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

`AWS::CloudWatch::Alarm.ExtendedStatistic`.

getInsufficientDataActions

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

`AWS::CloudWatch::Alarm.InsufficientDataActions`.

getMetricName

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

`AWS::CloudWatch::Alarm.MetricName`.

getMetrics

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

`AWS::CloudWatch::Alarm.Metrics`.

getNamespace

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

`AWS::CloudWatch::Alarm.Namespace`.

getOkActions

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

`AWS::CloudWatch::Alarm.OKActions`.

getPeriod

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

`AWS::CloudWatch::Alarm.Period`.

getStatistic

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

`AWS::CloudWatch::Alarm.Statistic`.

getThreshold

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

`AWS::CloudWatch::Alarm.Threshold`.

getThresholdMetricId

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

`AWS::CloudWatch::Alarm.ThresholdMetricId`.

getTreatMissingData

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

`AWS::CloudWatch::Alarm.TreatMissingData`.

getUnit

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

`AWS::CloudWatch::Alarm.Unit`.

builder

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

Returns:

a CfnAlarmProps.Builder of CfnAlarmProps