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

Interface CfnAlarmModelMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarmModelMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:28.535Z")
@Stability(Stable)
public interface CfnAlarmModelMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnAlarmModelPropsMixin.

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.*;
 CfnAlarmModelMixinProps cfnAlarmModelMixinProps = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAlarmModelMixinProps.Builder	builder()
default Object	getAlarmCapabilities()	Contains the configuration information of alarm state changes.
default Object	getAlarmEventActions()	Contains information about one or more alarm actions.
default String	getAlarmModelDescription()	The description of the alarm model.
default String	getAlarmModelName()	The name of the alarm model.
default Object	getAlarmRule()	Defines when your alarm is invoked.
default String	getKey()	An input attribute used as a key to create an alarm.
default String	getRoleArn()	The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
default Number	getSeverity()	A non-negative integer that reflects the severity level of the alarm.
default List<CfnTag>	getTags()	A list of key-value pairs that contain metadata for the alarm model.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarmCapabilities

@Stability(Stable)
@Nullable
default Object getAlarmCapabilities()

Contains the configuration information of alarm state changes.

Returns union: either IResolvable or CfnAlarmModelPropsMixin.AlarmCapabilitiesProperty

See Also:

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

getAlarmEventActions

@Stability(Stable)
@Nullable
default Object getAlarmEventActions()

Contains information about one or more alarm actions.

Returns union: either IResolvable or CfnAlarmModelPropsMixin.AlarmEventActionsProperty

See Also:

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

getAlarmModelDescription

@Stability(Stable)
@Nullable
default String getAlarmModelDescription()

The description of the alarm model.

See Also:

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

getAlarmModelName

@Stability(Stable)
@Nullable
default String getAlarmModelName()

The name of the alarm model.

See Also:

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

getAlarmRule

@Stability(Stable)
@Nullable
default Object getAlarmRule()

Defines when your alarm is invoked.

Returns union: either IResolvable or CfnAlarmModelPropsMixin.AlarmRuleProperty

See Also:

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

getKey

@Stability(Stable)
@Nullable
default String getKey()

An input attribute used as a key to create an alarm.

AWS IoT Events routes inputs associated with this key to the alarm.

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.

For more information, see Amazon Resource Names (ARNs) in the AWS General Reference .

See Also:

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

getSeverity

@Stability(Stable)
@Nullable
default Number getSeverity()

A non-negative integer that reflects the severity level of the alarm.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of key-value pairs that contain metadata for the alarm model.

The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide .

You can create up to 50 tags for one alarm model.

See Also:

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

builder

@Stability(Stable)
static CfnAlarmModelMixinProps.Builder builder()

Returns:

a CfnAlarmModelMixinProps.Builder of CfnAlarmModelMixinProps