The CDK Construct Library for AWS::IoTEvents
Project description
AWS::IoTEvents Construct Library
---AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.
AWS IoT Events enables you to monitor your equipment or device fleets for failures or changes in operation, and to trigger actions when such events occur.
Installation
Install the module:
$ npm i @aws-cdk/aws-iotevents
Import it into your code:
import aws_cdk.aws_iotevents as iotevents
DetectorModel
The following example creates an AWS IoT Events detector model to your stack. The detector model need a reference to at least one AWS IoT Events input. AWS IoT Events inputs enable the detector to get MQTT payload values from IoT Core rules.
You can define built-in actions to use a timer or set a variable, or send data to other AWS resources. See also @aws-cdk/aws-iotevents-actions for other actions.
import aws_cdk.aws_iotevents as iotevents
import aws_cdk.aws_iotevents_actions as actions
import aws_cdk.aws_lambda as lambda_
# func: lambda.IFunction
input = iotevents.Input(self, "MyInput",
input_name="my_input", # optional
attribute_json_paths=["payload.deviceId", "payload.temperature"]
)
warm_state = iotevents.State(
state_name="warm",
on_enter=[iotevents.Event(
event_name="test-enter-event",
condition=iotevents.Expression.current_input(input),
actions=[actions.LambdaInvokeAction(func)]
)],
on_input=[iotevents.Event( # optional
event_name="test-input-event",
actions=[actions.LambdaInvokeAction(func)])],
on_exit=[iotevents.Event( # optional
event_name="test-exit-event",
actions=[actions.LambdaInvokeAction(func)])]
)
cold_state = iotevents.State(
state_name="cold"
)
# transit to coldState when temperature is less than 15
warm_state.transition_to(cold_state,
event_name="to_coldState", # optional property, default by combining the names of the States
when=iotevents.Expression.lt(
iotevents.Expression.input_attribute(input, "payload.temperature"),
iotevents.Expression.from_string("15")),
executing=[actions.LambdaInvokeAction(func)]
)
# transit to warmState when temperature is greater than or equal to 15
cold_state.transition_to(warm_state,
when=iotevents.Expression.gte(
iotevents.Expression.input_attribute(input, "payload.temperature"),
iotevents.Expression.from_string("15"))
)
iotevents.DetectorModel(self, "MyDetectorModel",
detector_model_name="test-detector-model", # optional
description="test-detector-model-description", # optional property, default is none
evaluation_method=iotevents.EventEvaluation.SERIAL, # optional property, default is iotevents.EventEvaluation.BATCH
detector_key="payload.deviceId", # optional property, default is none and single detector instance will be created and all inputs will be routed to it
initial_state=warm_state
)
To grant permissions to put messages in the input,
you can use the grantWrite()
method:
import aws_cdk.aws_iam as iam
import aws_cdk.aws_iotevents as iotevents
# grantable: iam.IGrantable
input = iotevents.Input.from_input_name(self, "MyInput", "my_input")
input.grant_write(grantable)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-cdk.aws-iotevents-1.204.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61c90fbcdd732b5c035354148b9103e5edc6216b2f999d23342efc6a780270c5 |
|
MD5 | 2486a0241c025d4613b13422a8cdd29a |
|
BLAKE2b-256 | dd2169e5875117c4bc444b33ee09e4f49ec7fbd33f167bafbdcb026855a71059 |
Hashes for aws_cdk.aws_iotevents-1.204.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37fc8a20bdcc3c307796f5d7f1b51581f3e640824bfc755ef463f41f24393334 |
|
MD5 | 879cbbb1eb3046f788af160abfd18441 |
|
BLAKE2b-256 | 058cad94a5c93630401693d0616113caf65bca12658162f66775e5d618bf91e1 |