Skip to content
v2.274.0

AWS::IoTEvents Construct Library ​

This module is part of the AWS Cloud Development Kit project.

ts
import * as iotevents from 'aws-cdk-lib/aws-iotevents';
python
import aws_cdk.aws_iotevents as iotevents
java
import software.amazon.awscdk.services.iotevents.*;
csharp
using Amazon.CDK.AWS.IoTEvents;
go
import iotevents "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:

<span class="package-reference">@aws-cdk/aws-iotevents-alpha</span>

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::IoTEvents.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnAlarmModelConstruct (L1)Represents an alarm model to monitor an AWS IoT Events input attribute.
CfnDetectorModelConstruct (L1)The AWS::IoTEvents::DetectorModel resource creates a detector model.
CfnInputConstruct (L1)The AWS::IoTEvents::Input resource creates an input.
CfnAlarmModel.AcknowledgeFlowPropertyStructSpecifies whether to get notified for alarm state changes.
CfnAlarmModel.AlarmActionPropertyStructSpecifies one of the following actions to receive notifications when the alarm state changes.
CfnAlarmModel.AlarmCapabilitiesPropertyStructContains the configuration information of alarm state changes.
CfnAlarmModel.AlarmEventActionsPropertyStructContains information about one or more alarm actions.
CfnAlarmModel.AlarmRulePropertyStructDefines when your alarm is invoked.
CfnAlarmModel.AssetPropertyTimestampPropertyStructA structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference .
CfnAlarmModel.AssetPropertyValuePropertyStructA structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference .
CfnAlarmModel.AssetPropertyVariantPropertyStructA structure that contains an asset property value.
CfnAlarmModel.DynamoDBPropertyStructDefines an action to write to the Amazon DynamoDB table that you created.
CfnAlarmModel.DynamoDBv2PropertyStructDefines an action to write to the Amazon DynamoDB table that you created.
CfnAlarmModel.FirehosePropertyStructSends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
CfnAlarmModel.InitializationConfigurationPropertyStructSpecifies the default alarm state.
CfnAlarmModel.IotEventsPropertyStructSends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
CfnAlarmModel.IotSiteWisePropertyStructSends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
CfnAlarmModel.IotTopicPublishPropertyStructInformation required to publish the MQTT message through the AWS IoT message broker.
CfnAlarmModel.LambdaPropertyStructCalls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
CfnAlarmModel.PayloadPropertyStructInformation needed to configure the payload.
CfnAlarmModel.SimpleRulePropertyStructA rule that compares an input property value to a threshold value with a comparison operator.
CfnAlarmModel.SnsPropertyStructInformation required to publish the Amazon SNS message.
CfnAlarmModel.SqsPropertyStructSends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
CfnAlarmModelPropsStructProperties for defining a CfnAlarmModel.
CfnDetectorModel.ActionPropertyStructAn action to be performed when the condition is TRUE.
CfnDetectorModel.AssetPropertyTimestampPropertyStructA structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference .
CfnDetectorModel.AssetPropertyValuePropertyStructA structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference .
CfnDetectorModel.AssetPropertyVariantPropertyStructA structure that contains an asset property value.
CfnDetectorModel.ClearTimerPropertyStructInformation needed to clear the timer.
CfnDetectorModel.DetectorModelDefinitionPropertyStructInformation that defines how a detector operates.
CfnDetectorModel.DynamoDBPropertyStructDefines an action to write to the Amazon DynamoDB table that you created.
CfnDetectorModel.DynamoDBv2PropertyStructDefines an action to write to the Amazon DynamoDB table that you created.
CfnDetectorModel.EventPropertyStructSpecifies the actions to be performed when the condition evaluates to TRUE.
CfnDetectorModel.FirehosePropertyStructSends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
CfnDetectorModel.IotEventsPropertyStructSends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
CfnDetectorModel.IotSiteWisePropertyStructSends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
CfnDetectorModel.IotTopicPublishPropertyStructInformation required to publish the MQTT message through the AWS IoT message broker.
CfnDetectorModel.LambdaPropertyStructCalls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
CfnDetectorModel.OnEnterPropertyStructWhen entering this state, perform these actions if the condition is TRUE.
CfnDetectorModel.OnExitPropertyStructWhen exiting this state, perform these actions if the specified condition is TRUE .
CfnDetectorModel.OnInputPropertyStructSpecifies the actions performed when the condition evaluates to TRUE.
CfnDetectorModel.PayloadPropertyStructInformation needed to configure the payload.
CfnDetectorModel.ResetTimerPropertyStructInformation required to reset the timer.
CfnDetectorModel.SetTimerPropertyStructInformation needed to set the timer.
CfnDetectorModel.SetVariablePropertyStructInformation about the variable and its new value.
CfnDetectorModel.SnsPropertyStructInformation required to publish the Amazon SNS message.
CfnDetectorModel.SqsPropertyStructSends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
CfnDetectorModel.StatePropertyStructInformation that defines a state of a detector.
CfnDetectorModel.TransitionEventPropertyStructSpecifies the actions performed and the next state entered when a condition evaluates to TRUE.
CfnDetectorModelPropsStructProperties for defining a CfnDetectorModel.
CfnInput.AttributePropertyStructThe attributes from the JSON payload that are made available by the input.
CfnInput.InputDefinitionPropertyStructThe definition of the input.
CfnInputPropsStructProperties for defining a CfnInput.