awssolutionsconstructsawsiotlambda

README

aws-iot-lambda module

---

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	aws_solutions_constructs.aws_iot_lambda
Typescript	@aws-solutions-constructs/aws-iot-lambda
Java	software.amazon.awsconstructs.services.iotlambda

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

Here is a minimal deployable pattern definition in Typescript:

const { IotToLambdaProps, IotToLambda } from '@aws-solutions-constructs/aws-iot-lambda';

const props: IotToLambdaProps = {
    lambdaFunctionProps: {
        code: lambda.Code.fromAsset(`${__dirname}/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', props);

Initializer

new IotToLambda(scope: Construct, id: string, props: IotToLambdaProps);

Parameters

• scope Construct
• id string
• props IotToLambdaProps

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

---

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

Documentation

Overview

CDK Constructs for AWS IoT to AWS Lambda integration

Index

• func IotToLambda_IsConstruct(x interface{}) *bool
• func NewIotToLambda_Override(i IotToLambda, scope constructs.Construct, id *string, props *IotToLambdaProps)
• type IotToLambda
  • func NewIotToLambda(scope constructs.Construct, id *string, props *IotToLambdaProps) IotToLambda
• type IotToLambdaProps

Functions

func IotToLambda_IsConstruct

func IotToLambda_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewIotToLambda_Override

func NewIotToLambda_Override(i IotToLambda, scope constructs.Construct, id *string, props *IotToLambdaProps)

Types

type IotToLambda

type IotToLambda interface {
	constructs.Construct
	IotTopicRule() awsiot.CfnTopicRule
	LambdaFunction() awslambda.Function
	Node() constructs.Node
	ToString() *string
}

func NewIotToLambda

func NewIotToLambda(scope constructs.Construct, id *string, props *IotToLambdaProps) IotToLambda

type IotToLambdaProps

type IotToLambdaProps struct {
	// User provided CfnTopicRuleProps to override the defaults.
	IotTopicRuleProps *awsiot.CfnTopicRuleProps `json:"iotTopicRuleProps"`
	// Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
	ExistingLambdaObj awslambda.Function `json:"existingLambdaObj"`
	// User provided props to override the default props for the Lambda function.
	LambdaFunctionProps *awslambda.FunctionProps `json:"lambdaFunctionProps"`
}