@aws-solutions-constructs/aws-iot-lambda
    TypeScript icon, indicating that this package has built-in type declarations

    2.12.0 • Public • Published

    aws-iot-lambda module


    Stability: Experimental

    All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. 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.


    Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
    Language Package
    Python Logo Python aws_solutions_constructs.aws_iot_lambda
    Typescript Logo Typescript @aws-solutions-constructs/aws-iot-lambda
    Java Logo Java software.amazon.awsconstructs.services.iotlambda

    Overview

    This AWS Solutions Construct implements an AWS IoT MQTT topic rule and an AWS Lambda function pattern.

    Here is a minimal deployable pattern definition:

    Typescript

    import { Construct } from 'constructs';
    import { Stack, StackProps } from 'aws-cdk-lib';
    import { IotToLambdaProps, IotToLambda } from '@aws-solutions-constructs/aws-iot-lambda';
    import * as lambda from 'aws-cdk-lib/aws-lambda';
    
    const constructProps: IotToLambdaProps = {
      lambdaFunctionProps: {
        code: lambda.Code.fromAsset(`lambda`),
        runtime: lambda.Runtime.NODEJS_14_X,
        handler: 'index.handler'
      },
      iotTopicRuleProps: {
        topicRulePayload: {
          ruleDisabled: false,
          description: "Processing of DTC messages from the AWS Connected Vehicle Solution.",
          sql: "SELECT * FROM 'connectedcar/dtc/#'",
          actions: []
        }
      }
    };
    
    new IotToLambda(this, 'test-iot-lambda-integration', constructProps);

    Python

    from aws_solutions_constructs.aws_iot_lambda import IotToLambdaProps, IotToLambda
    from aws_cdk import (
        aws_iot as iot,
        aws_lambda as _lambda,
        Stack
    )
    from constructs import Construct
    
    IotToLambda(self, 'test_iot_lambda',
                lambda_function_props=_lambda.FunctionProps(
                    code=_lambda.Code.from_asset('lambda'),
                    runtime=_lambda.Runtime.PYTHON_3_9,
                    handler='index.handler'
                ),
                iot_topic_rule_props=iot.CfnTopicRuleProps(
                    topic_rule_payload=iot.CfnTopicRule.TopicRulePayloadProperty(
                        rule_disabled=False,
                        description="Sends data to kinesis data stream",
                        sql="SELECT * FROM 'solutions/construct'",
                        actions=[]
                    )
                ))

    Java

    import software.constructs.Construct;
    import java.util.List;
    
    import software.amazon.awscdk.Stack;
    import software.amazon.awscdk.StackProps;
    import software.amazon.awscdk.services.lambda.*;
    import software.amazon.awscdk.services.lambda.Runtime;
    import software.amazon.awscdk.services.iot.*;
    import software.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty;
    import software.amazon.awsconstructs.services.iotlambda.*;
    
    new IotToLambda(this, "test-iot-lambda-integration", new IotToLambdaProps.Builder()
            .lambdaFunctionProps(new FunctionProps.Builder()
                    .runtime(Runtime.NODEJS_14_X)
                    .code(Code.fromAsset("lambda"))
                    .handler("index.handler")
                    .build())
            .iotTopicRuleProps(new CfnTopicRuleProps.Builder()
                    .topicRulePayload(new TopicRulePayloadProperty.Builder()
                            .ruleDisabled(false)
                            .description("Processing of DTC messages from the AWS Connected Vehicle Solution.")
                            .sql("SELECT * FROM 'connectedcar/dtc/#'")
                            .actions(List.of())
                            .build())
                    .build())
            .build());

    Pattern Construct Props

    Name Type Description
    existingLambdaObj? lambda.Function Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
    lambdaFunctionProps? lambda.FunctionProps User provided props to override the default props for the Lambda function.
    iotTopicRuleProps? iot.CfnTopicRuleProps User provided CfnTopicRuleProps to override the defaults

    Pattern Properties

    Name Type Description
    iotTopicRule iot.CfnTopicRule Returns an instance of iot.CfnTopicRule created by the construct
    lambdaFunction lambda.Function Returns an instance of lambda.Function created by the construct

    Default settings

    Out of the box implementation of the Construct without any override will set the following defaults:

    Amazon IoT Rule

    • Configure least privilege access IAM role for Amazon IoT

    AWS Lambda Function

    • Configure limited privilege access IAM role for Lambda function
    • Enable reusing connections with Keep-Alive for NodeJs Lambda function
    • Enable X-Ray Tracing
    • Set Environment Variables
      • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

    Architecture

    Architecture Diagram


    © Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.

    Install

    npm i @aws-solutions-constructs/aws-iot-lambda

    DownloadsWeekly Downloads

    2,427

    Version

    2.12.0

    License

    Apache-2.0

    Unpacked Size

    220 kB

    Total Files

    16

    Last publish

    Collaborators

    • aws-solutions-constructs-team