This release is a pre-release and may not be stable for production use.
Actions for AWS::IoTEvents Detector Model
---
The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
This library contains integration classes to specify actions of state events of Detector Model in @aws-cdk/aws-iotevents-alpha.
Instances of these classes should be passed to State defined in @aws-cdk/aws-iotevents-alpha
You can define built-in actions to use a timer or set a variable, or send data to other AWS resources.
This library contains integration classes to use a timer or set a variable, or send data to other AWS resources. AWS IoT Events can trigger actions when it detects a specified event or transition event.
Currently supported are:
- Use timer
- Set variable to detector instance
- Invoke a Lambda function
Use timer
The code snippet below creates an Action that creates the timer with duration in seconds.
# Example automatically generated from non-compiling source. May contain errors.
import aws_cdk.aws_iotevents_alpha as iotevents
import aws_cdk.aws_iotevents_actions_alpha as actions
# input: iotevents.IInput
state = iotevents.State(
state_name="MyState",
on_enter=[iotevents.Event(
event_name="test-event",
condition=iotevents.Expression.current_input(input),
actions=[
actions.SetTimerAction("MyTimer", {
"duration": cdk.Duration.seconds(60)
})
]
)]
)
Setting duration by IoT Events Expression:
# Example automatically generated from non-compiling source. May contain errors.
actions.SetTimerAction("MyTimer",
duration_expression=iotevents.Expression.input_attribute(input, "payload.durationSeconds")
)
And the timer can be reset and cleared. Below is an example of general Device HeartBeat Detector Model:
# Example automatically generated from non-compiling source. May contain errors.
online = iotevents.State(
state_name="Online",
on_enter=[{
"event_name": "enter-event",
"condition": iotevents.Expression.current_input(input),
"actions": [
actions.SetTimerAction("MyTimer",
duration=cdk.Duration.seconds(60)
)
]
}],
on_input=[{
"event_name": "input-event",
"condition": iotevents.Expression.current_input(input),
"actions": [
actions.ResetTimerAction("MyTimer")
]
}],
on_exit=[{
"event_name": "exit-event",
"actions": [
actions.ClearTimerAction("MyTimer")
]
}]
)
offline = iotevents.State(state_name="Offline")
online.transition_to(offline, when=iotevents.Expression.timeout("MyTimer"))
offline.transition_to(online, when=iotevents.Expression.current_input(input))
Set variable to detector instance
The code snippet below creates an Action that set variable to detector instance when it is triggered.
import aws_cdk.aws_iotevents_alpha as iotevents
import aws_cdk.aws_iotevents_actions_alpha as actions
# input: iotevents.IInput
state = iotevents.State(
state_name="MyState",
on_enter=[iotevents.Event(
event_name="test-event",
condition=iotevents.Expression.current_input(input),
actions=[
actions.SetVariableAction("MyVariable",
iotevents.Expression.input_attribute(input, "payload.temperature"))
]
)]
)
Invoke a Lambda function
The code snippet below creates an Action that invoke a Lambda function when it is triggered.
import aws_cdk.aws_iotevents_alpha as iotevents
import aws_cdk.aws_iotevents_actions_alpha as actions
import aws_cdk.aws_lambda as lambda_
# input: iotevents.IInput
# func: lambda.IFunction
state = iotevents.State(
state_name="MyState",
on_enter=[iotevents.Event(
event_name="test-event",
condition=iotevents.Expression.current_input(input),
actions=[actions.LambdaInvokeAction(func)]
)]
)
2 maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aws_cdk_aws_iotevents_actions_alpha-2.263.0a0.tar.gz.
File metadata
- Download URL: aws_cdk_aws_iotevents_actions_alpha-2.263.0a0.tar.gz
- Upload date:
- Size: 54.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
496d93a2fac55d61b2d848b8df295edaa4a9e45fefba03b9e62873aa37e659ec
|
|
| MD5 |
d90622ce6600f62d150640fb5f29bd86
|
|
| BLAKE2b-256 |
c258f10e982a9fed7dc5fd00dd8b08619a51f3e135f7b48299072abd8c95125d
|
File details
Details for the file aws_cdk_aws_iotevents_actions_alpha-2.263.0a0-py3-none-any.whl.
File metadata
- Download URL: aws_cdk_aws_iotevents_actions_alpha-2.263.0a0-py3-none-any.whl
- Upload date:
- Size: 53.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e780c2acf042c1274a9bf0cb702d87ad2cf174d903fb4846b50e42028633c099
|
|
| MD5 |
c53ecaf5469319dd3e1997d44ff06f0b
|
|
| BLAKE2b-256 |
75800ece74379d956a8b50c0d80d2abd51d12226f3b4e7604abd3c60d42c64bc
|
