@aws-solutions-konstruk/aws-iot-lambda
v0.8.1
Published
CDK Constructs for AWS IoT to AWS Lambda integration
Downloads
13
Readme
aws-iot-lambda module
This is a developer preview (public beta) 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.
| API Reference:| http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-iot-lambda/| |:-------------|:-------------|
| Language | Package |
|:-------------|-----------------|
|{: style="height:16px;width:16px"} Python|aws_solutions_konstruk.aws_iot_lambda
|
|{: style="height:16px;width:16px"} Typescript|@aws-solutions-konstruk/aws-iot-lambda
|
This AWS Solutions Konstruk implements an AWS IoT MQTT topic rule and an AWS Lambda function pattern.
Here is a minimal deployable pattern definition:
const { IotToLambdaProps, IotToLambda } = require('@aws-solutions-konstruk/aws-iot-lambda');
const props: IotToLambdaProps = {
deployLambda: true,
lambdaFunctionProps: {
code: lambda.Code.asset(`${__dirname}/lambda`),
runtime: lambda.Runtime.NODEJS_10_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(stack, '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 |
|:-------------|:----------------|-----------------|
|deployLambda|boolean
|Whether to create a new lambda function or use an existing lambda function|
|existingLambdaObj?|lambda.Function
|Existing instance of Lambda Function object|
|lambdaFunctionProps?|lambda.FunctionProps
|Optional user provided props to override the default props for 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|
Architecture
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.