Package software.amazon.awscdk.services.iotevents

Interface CfnAlarmModelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarmModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.114Z")
@Stability(Stable)
public interface CfnAlarmModelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAlarmModel.

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.iotevents.*;
 CfnAlarmModelProps cfnAlarmModelProps = CfnAlarmModelProps.builder()
         .alarmRule(AlarmRuleProperty.builder()
                 .simpleRule(SimpleRuleProperty.builder()
                         .comparisonOperator("comparisonOperator")
                         .inputProperty("inputProperty")
                         .threshold("threshold")
                         .build())
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .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")
                                 .hashKeyValue("hashKeyValue")
                                 .tableName("tableName")
                                 // the properties below are optional
                                 .hashKeyType("hashKeyType")
                                 .operation("operation")
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .payloadField("payloadField")
                                 .rangeKeyField("rangeKeyField")
                                 .rangeKeyType("rangeKeyType")
                                 .rangeKeyValue("rangeKeyValue")
                                 .build())
                         .dynamoDBv2(DynamoDBv2Property.builder()
                                 .tableName("tableName")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .firehose(FirehoseProperty.builder()
                                 .deliveryStreamName("deliveryStreamName")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .separator("separator")
                                 .build())
                         .iotEvents(IotEventsProperty.builder()
                                 .inputName("inputName")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .iotSiteWise(IotSiteWiseProperty.builder()
                                 .assetId("assetId")
                                 .entryId("entryId")
                                 .propertyAlias("propertyAlias")
                                 .propertyId("propertyId")
                                 .propertyValue(AssetPropertyValueProperty.builder()
                                         .value(AssetPropertyVariantProperty.builder()
                                                 .booleanValue("booleanValue")
                                                 .doubleValue("doubleValue")
                                                 .integerValue("integerValue")
                                                 .stringValue("stringValue")
                                                 .build())
                                         // the properties below are optional
                                         .quality("quality")
                                         .timestamp(AssetPropertyTimestampProperty.builder()
                                                 .timeInSeconds("timeInSeconds")
                                                 // the properties below are optional
                                                 .offsetInNanos("offsetInNanos")
                                                 .build())
                                         .build())
                                 .build())
                         .iotTopicPublish(IotTopicPublishProperty.builder()
                                 .mqttTopic("mqttTopic")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .lambda(LambdaProperty.builder()
                                 .functionArn("functionArn")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .sns(SnsProperty.builder()
                                 .targetArn("targetArn")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .sqs(SqsProperty.builder()
                                 .queueUrl("queueUrl")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .useBase64(false)
                                 .build())
                         .build()))
                 .build())
         .alarmModelDescription("alarmModelDescription")
         .alarmModelName("alarmModelName")
         .key("key")
         .severity(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAlarmModelProps.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.
Object	getAlarmRule()	Defines when your alarm is invoked.
default String	getKey()	An input attribute used as a key to create an alarm.
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

getAlarmRule

@Stability(Stable)
@NotNull
Object getAlarmRule()

Defines when your alarm is invoked.

getRoleArn

@Stability(Stable)
@NotNull
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 .

getAlarmCapabilities

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

Contains the configuration information of alarm state changes.

getAlarmEventActions

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

Contains information about one or more alarm actions.

getAlarmModelDescription

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

The description of the alarm model.

getAlarmModelName

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

The name of the alarm model.

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.

getSeverity

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

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

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.

builder

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

Returns:

a CfnAlarmModelProps.Builder of CfnAlarmModelProps