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

    2.2.0 • Public • Published

    aws-iot-lambda-dynamodb 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_dynamodb
    Typescript Logo Typescript @aws-solutions-constructs/aws-iot-lambda-dynamodb
    Java Logo Java software.amazon.awsconstructs.services.iotlambdadynamodb

    This AWS Solutions Construct implements an AWS IoT topic rule, an AWS Lambda function and Amazon DynamoDB table with the least privileged permissions.

    Here is a minimal deployable pattern definition in Typescript:

    const { IotToLambdaToDynamoDBProps,  IotToLambdaToDynamoDB } from '@aws-solutions-constructs/aws-iot-lambda-dynamodb';
    
    const props: IotToLambdaToDynamoDBProps = {
        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 IotToLambdaToDynamoDB(this, 'test-iot-lambda-dynamodb-stack', props);

    Initializer

    new IotToLambdaToDynamoDB(scope: Construct, id: string, props: IotToLambdaToDynamoDBProps);
    

    Parameters

    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 props to override the default props
    dynamoTableProps? dynamodb.TableProps Optional user provided props to override the default props for DynamoDB Table
    tablePermissions? string Optional table permissions to grant to the Lambda function. One of the following may be specified: All, Read, ReadWrite, Write.

    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
    dynamoTable dynamodb.Table Returns an instance of dynamodb.Table 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)

    Amazon DynamoDB Table

    • Set the billing mode for DynamoDB Table to On-Demand (Pay per request)
    • Enable server-side encryption for DynamoDB Table using AWS managed KMS Key
    • Creates a partition key called 'id' for DynamoDB Table
    • Retain the Table when deleting the CloudFormation stack
    • Enable continuous backups and point-in-time recovery

    Architecture

    Architecture Diagram


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

    Install

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

    DownloadsWeekly Downloads

    128

    Version

    2.2.0

    License

    Apache-2.0

    Unpacked Size

    236 kB

    Total Files

    13

    Last publish

    Collaborators

    • aws-solutions-constructs-team