Package software.amazon.awscdk.cfnpropertymixins.services.cloudwatch

Class CfnAlarmPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.cloudwatch.CfnAlarmPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.179Z")
@Stability(Stable)
public class CfnAlarmPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA . The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the 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.cfnpropertymixins.services.cloudwatch.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAlarmPropsMixin cfnAlarmPropsMixin = CfnAlarmPropsMixin.Builder.create(CfnAlarmMixinProps.builder()
         .actionsEnabled(false)
         .alarmActions(List.of("alarmActions"))
         .alarmDescription("alarmDescription")
         .alarmName("alarmName")
         .comparisonOperator("comparisonOperator")
         .datapointsToAlarm(123)
         .dimensions(List.of(DimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .evaluateLowSampleCountPercentile("evaluateLowSampleCountPercentile")
         .evaluationPeriods(123)
         .extendedStatistic("extendedStatistic")
         .insufficientDataActions(List.of("insufficientDataActions"))
         .metricName("metricName")
         .metrics(List.of(MetricDataQueryProperty.builder()
                 .accountId("accountId")
                 .expression("expression")
                 .id("id")
                 .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")
                         .unit("unit")
                         .build())
                 .period(123)
                 .returnData(false)
                 .build()))
         .namespace("namespace")
         .okActions(List.of("okActions"))
         .period(123)
         .statistic("statistic")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .threshold(123)
         .thresholdMetricId("thresholdMetricId")
         .treatMissingData("treatMissingData")
         .unit("unit")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnAlarmPropsMixin.Builder	A fluent builder for CfnAlarmPropsMixin.
static interface	CfnAlarmPropsMixin.DimensionProperty	Dimension is an embedded property of the AWS::CloudWatch::Alarm type.
static interface	CfnAlarmPropsMixin.MetricDataQueryProperty	The MetricDataQuery property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data.
static interface	CfnAlarmPropsMixin.MetricProperty	The Metric property type represents a specific metric.
static interface	CfnAlarmPropsMixin.MetricStatProperty	This structure defines the metric to be returned, along with the statistics, period, and units.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAlarmPropsMixin(CfnAlarmMixinProps props)	Create a mixin to apply properties to AWS::CloudWatch::Alarm.
	CfnAlarmPropsMixin(CfnAlarmMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::CloudWatch::Alarm.
protected	CfnAlarmPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAlarmPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnAlarmMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnAlarmPropsMixin

protected CfnAlarmPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnAlarmPropsMixin

protected CfnAlarmPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAlarmPropsMixin

@Stability(Stable)
public CfnAlarmPropsMixin(@NotNull
 CfnAlarmMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::CloudWatch::Alarm.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnAlarmPropsMixin

@Stability(Stable)
public CfnAlarmPropsMixin(@NotNull
 CfnAlarmMixinProps props)

Create a mixin to apply properties to AWS::CloudWatch::Alarm.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnAlarmMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()