@aws-cdk/aws-iot

AWS IoT Construct Library

---

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

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.

---

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 * as iot from '@aws-cdk/aws-iot';

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:

const func = new lambda.Function(this, 'MyFunction', {
  runtime: lambda.Runtime.NODEJS_14_X,
  handler: 'index.handler',
  code: lambda.Code.fromInline(`
    exports.handler = (event) => {
      console.log("It is test for lambda action of AWS IoT Rule.", event);
    };`
  ),
});

new iot.TopicRule(this, 'TopicRule', {
  topicRuleName: 'MyTopicRule', // optional
  description: 'invokes the lambda function', // optional
  sql: iot.IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'"),
  actions: [new actions.LambdaFunctionAction(func)],
});

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

declare const func: lambda.Function;

const topicRule = new iot.TopicRule(this, 'TopicRule', {
  sql: iot.IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'"),
});
topicRule.addAction(new 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 * as logs from '@aws-cdk/aws-logs';

const logGroup = new logs.LogGroup(this, 'MyLogGroup');

new iot.TopicRule(this, 'TopicRule', {
  sql: iot.IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'"),
  errorAction: new actions.CloudWatchLogsAction(logGroup),
});

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

new iot.TopicRule(this, 'TopicRule', {
  sql: iot.IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'"),
  enabled: false,
});

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

Changelog

1.148.0 (2022-03-09)

Features

• aws-apigateway: add ability to include authorizer context in apigw sfn integration (#18892) (e7c0c75), closes #18891
• aws-s3objectlambda: add L2 construct for S3 Object Lambda (#15833) (fe9f750), closes #13675
• cfnspec: cloudformation spec v59.0.0 (#19236) (f46a14d)
• codebuild: improved support for ARM build images (#19052) (4eac4de), closes #18916 #9817
• eks: Service Account names validation (#19251) (7c3099e), closes #18189
• elasticsearch: Decouple setting access policies from domain constructor (#15876) (cefdfd3)
• iotevents: support actions (#18869) (e01654e)
• iotevents: support setting Events on input and exit for State (#19249) (ffa9e0d)
• lambda-nodejs: support esbuild inject (#19221) (3432c45), closes #19133
• s3: add s3:ObjectRestore:Delete to EventType for notification (#19250) (e0f863a), closes #19223
• servicecatalog: Service Catalog is now in Developer Preview (#19204) (6dfc254)

Bug Fixes

• apigatewayv2-integrations: in case of multiple routes, only one execute permission is created (#18716) (1e352ca)
• aws-apigateway: missing comma to make failure response payload valid json (#19253) (b1fce4f), closes #19252
• aws-route53-targets: add support for custom cname_prefix urls in elastic beanstalk environment endpoint target (#18804) (289a794)
• cli: watch logs always end with the 'truncated' message (#19241) (d3fdfe5), closes #18805
• cli: deprecated stack ids printed at the end of synth (#19216) (7d8a479), closes #18599
• cli: notices refresh doesn't respect the --no-notices flag (#19226) (b3c5fe8)
• efs: fix bug when setting both lifecyclePolicy and outOfInfrequentAccessPolicy (#19082) (d435ab6), closes #19058
• lambda-nodejs: local tsc detection with pre compilation (#19266) (5de7b86), closes #19242
• lambda-python: asset bundling fails on windows (#19270) (0da57da), closes #18861
• lambda-python: docker image gets built even when we don't need to bundle assets (#16192) (5dc61ea), closes #14747
• rds: allow cluster from snapshot to enable encrypted storage (#19175) (bd4141d), closes #17241
• rds: read replica instance cannot join domain (#19202) (cef8fec), closes #18786
• rds: subnet selection not respected for multi user secret rotation (#19237) (dc7a17c), closes #19233