Skip to main content

The CDK Construct Library for AWS::IoT

Project description

AWS IoT Construct Library

---

End-of-Support

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 Core lets you connect billions of IoT devices and route trillions of messages to AWS services without managing infrastructure.

Installation

Install the module:

$ npm i @aws-cdk/aws-iot

Import it into your code:

import aws_cdk.aws_iot as iot
import aws_cdk.aws_iot_actions as actions

TopicRule

Create a topic rule that give your devices the ability to interact with AWS services. You can create a topic rule with an action that invoke the Lambda action as following:

func = lambda_.Function(self, "MyFunction",
    runtime=lambda_.Runtime.NODEJS_14_X,
    handler="index.handler",
    code=lambda_.Code.from_inline("""
            exports.handler = (event) => {
              console.log("It is test for lambda action of AWS IoT Rule.", event);
            };""")
)

iot.TopicRule(self, "TopicRule",
    topic_rule_name="MyTopicRule",  # optional
    description="invokes the lambda function",  # optional
    sql=iot.IotSql.from_string_as_ver20160323("SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'"),
    actions=[actions.LambdaFunctionAction(func)]
)

Or, you can add an action after constructing the TopicRule instance as following:

# func: lambda.Function


topic_rule = iot.TopicRule(self, "TopicRule",
    sql=iot.IotSql.from_string_as_ver20160323("SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'")
)
topic_rule.add_action(actions.LambdaFunctionAction(func))

You can also supply errorAction as following, and the IoT Rule will trigger it if a rule's action is unable to perform:

import aws_cdk.aws_logs as logs


log_group = logs.LogGroup(self, "MyLogGroup")

iot.TopicRule(self, "TopicRule",
    sql=iot.IotSql.from_string_as_ver20160323("SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'"),
    error_action=actions.CloudWatchLogsAction(log_group)
)

If you wanna make the topic rule disable, add property enabled: false as following:

iot.TopicRule(self, "TopicRule",
    sql=iot.IotSql.from_string_as_ver20160323("SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'"),
    enabled=False
)

See also @aws-cdk/aws-iot-actions for other actions.

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

aws-cdk.aws-iot-1.204.0.tar.gz (509.3 kB view details)

Uploaded Source

Built Distribution

aws_cdk.aws_iot-1.204.0-py3-none-any.whl (511.1 kB view details)

Uploaded Python 3

File details

Details for the file aws-cdk.aws-iot-1.204.0.tar.gz.

File metadata

  • Download URL: aws-cdk.aws-iot-1.204.0.tar.gz
  • Upload date:
  • Size: 509.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for aws-cdk.aws-iot-1.204.0.tar.gz
Algorithm Hash digest
SHA256 d245a60d08d829e56a38315dd170df568c2e9c8639113a0296bb21b57c467874
MD5 0a409276af6d9924483cae1812d4d649
BLAKE2b-256 bd21280ef0c9ce7f6990f68e7f687dc4e6ffd31f352182ee7bf920b2f16ae299

See more details on using hashes here.

File details

Details for the file aws_cdk.aws_iot-1.204.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_cdk.aws_iot-1.204.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ac014fdd63c456b17bee36371c97980a4cd07ee652c3f5ec633a39f22e96377
MD5 3da4d95d894e5726f78a59212438f6a7
BLAKE2b-256 a44eb9449bfbb3f0a91e01d3d9d5605c6d7c8e397718d97b5eb6e58df8b948cf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page