Package software.amazon.awscdk.cfnpropertymixins.services.iotevents

Class CfnAlarmModelPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.iotevents.CfnAlarmModelPropsMixin

All Implemented Interfaces:

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

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

Represents an alarm model to monitor an AWS IoT Events input attribute.

You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide .

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.iotevents.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAlarmModelPropsMixin cfnAlarmModelPropsMixin = CfnAlarmModelPropsMixin.Builder.create(CfnAlarmModelMixinProps.builder()
         .alarmCapabilities(AlarmCapabilitiesProperty.builder()
                 .acknowledgeFlow(AcknowledgeFlowProperty.builder()
                         .enabled(false)
                         .build())
                 .initializationConfiguration(InitializationConfigurationProperty.builder()
                         .disabledOnInitialization(false)
                         .build())
                 .build())
         .alarmEventActions(AlarmEventActionsProperty.builder()
                 .alarmActions(List.of(AlarmActionProperty.builder()
                         .dynamoDb(DynamoDBProperty.builder()
                                 .hashKeyField("hashKeyField")
                                 .hashKeyType("hashKeyType")
                                 .hashKeyValue("hashKeyValue")
                                 .operation("operation")
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .payloadField("payloadField")
                                 .rangeKeyField("rangeKeyField")
                                 .rangeKeyType("rangeKeyType")
                                 .rangeKeyValue("rangeKeyValue")
                                 .tableName("tableName")
                                 .build())
                         .dynamoDBv2(DynamoDBv2Property.builder()
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .tableName("tableName")
                                 .build())
                         .firehose(FirehoseProperty.builder()
                                 .deliveryStreamName("deliveryStreamName")
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .separator("separator")
                                 .build())
                         .iotEvents(IotEventsProperty.builder()
                                 .inputName("inputName")
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .iotSiteWise(IotSiteWiseProperty.builder()
                                 .assetId("assetId")
                                 .entryId("entryId")
                                 .propertyAlias("propertyAlias")
                                 .propertyId("propertyId")
                                 .propertyValue(AssetPropertyValueProperty.builder()
                                         .quality("quality")
                                         .timestamp(AssetPropertyTimestampProperty.builder()
                                                 .offsetInNanos("offsetInNanos")
                                                 .timeInSeconds("timeInSeconds")
                                                 .build())
                                         .value(AssetPropertyVariantProperty.builder()
                                                 .booleanValue("booleanValue")
                                                 .doubleValue("doubleValue")
                                                 .integerValue("integerValue")
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .build())
                         .iotTopicPublish(IotTopicPublishProperty.builder()
                                 .mqttTopic("mqttTopic")
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .lambda(LambdaProperty.builder()
                                 .functionArn("functionArn")
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .sns(SnsProperty.builder()
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .targetArn("targetArn")
                                 .build())
                         .sqs(SqsProperty.builder()
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .queueUrl("queueUrl")
                                 .useBase64(false)
                                 .build())
                         .build()))
                 .build())
         .alarmModelDescription("alarmModelDescription")
         .alarmModelName("alarmModelName")
         .alarmRule(AlarmRuleProperty.builder()
                 .simpleRule(SimpleRuleProperty.builder()
                         .comparisonOperator("comparisonOperator")
                         .inputProperty("inputProperty")
                         .threshold("threshold")
                         .build())
                 .build())
         .key("key")
         .roleArn("roleArn")
         .severity(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnAlarmModelPropsMixin.AcknowledgeFlowProperty	Specifies whether to get notified for alarm state changes.
static interface	CfnAlarmModelPropsMixin.AlarmActionProperty	Specifies one of the following actions to receive notifications when the alarm state changes.
static interface	CfnAlarmModelPropsMixin.AlarmCapabilitiesProperty	Contains the configuration information of alarm state changes.
static interface	CfnAlarmModelPropsMixin.AlarmEventActionsProperty	Contains information about one or more alarm actions.
static interface	CfnAlarmModelPropsMixin.AlarmRuleProperty	Defines when your alarm is invoked.
static interface	CfnAlarmModelPropsMixin.AssetPropertyTimestampProperty	A structure that contains timestamp information.
static interface	CfnAlarmModelPropsMixin.AssetPropertyValueProperty	A structure that contains value information.
static interface	CfnAlarmModelPropsMixin.AssetPropertyVariantProperty	A structure that contains an asset property value.
static final class	CfnAlarmModelPropsMixin.Builder	A fluent builder for CfnAlarmModelPropsMixin.
static interface	CfnAlarmModelPropsMixin.DynamoDBProperty	Defines an action to write to the Amazon DynamoDB table that you created.
static interface	CfnAlarmModelPropsMixin.DynamoDBv2Property	Defines an action to write to the Amazon DynamoDB table that you created.
static interface	CfnAlarmModelPropsMixin.FirehoseProperty	Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
static interface	CfnAlarmModelPropsMixin.InitializationConfigurationProperty	Specifies the default alarm state.
static interface	CfnAlarmModelPropsMixin.IotEventsProperty	Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
static interface	CfnAlarmModelPropsMixin.IotSiteWiseProperty	Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
static interface	CfnAlarmModelPropsMixin.IotTopicPublishProperty	Information required to publish the MQTT message through the AWS IoT message broker.
static interface	CfnAlarmModelPropsMixin.LambdaProperty	Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
static interface	CfnAlarmModelPropsMixin.PayloadProperty	Information needed to configure the payload.
static interface	CfnAlarmModelPropsMixin.SimpleRuleProperty	A rule that compares an input property value to a threshold value with a comparison operator.
static interface	CfnAlarmModelPropsMixin.SnsProperty	Information required to publish the Amazon SNS message.
static interface	CfnAlarmModelPropsMixin.SqsProperty	Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

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
	CfnAlarmModelPropsMixin(CfnAlarmModelMixinProps props)	Create a mixin to apply properties to AWS::IoTEvents::AlarmModel.
	CfnAlarmModelPropsMixin(CfnAlarmModelMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::IoTEvents::AlarmModel.
protected	CfnAlarmModelPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAlarmModelPropsMixin(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 CfnAlarmModelMixinProps	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

CfnAlarmModelPropsMixin

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

CfnAlarmModelPropsMixin

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

CfnAlarmModelPropsMixin

@Stability(Stable)
public CfnAlarmModelPropsMixin(@NotNull
 CfnAlarmModelMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::IoTEvents::AlarmModel.

Parameters:

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

options - Mixin options.

CfnAlarmModelPropsMixin

@Stability(Stable)
public CfnAlarmModelPropsMixin(@NotNull
 CfnAlarmModelMixinProps props)

Create a mixin to apply properties to AWS::IoTEvents::AlarmModel.

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 CfnAlarmModelMixinProps getProps()

getStrategy

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