CDK Constructs for AWS SNS to AWS Lambda integration
Project description
aws-sns-lambda module
---Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_sns_lambda |
Typescript | @aws-solutions-constructs/aws-sns-lambda |
Java | software.amazon.awsconstructs.services.snslambda |
Overview
This AWS Solutions Construct implements an Amazon SNS connected to an AWS Lambda function.
Here is a minimal deployable pattern definition:
Typescript
import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { SnsToLambda, SnsToLambdaProps } from "@aws-solutions-constructs/aws-sns-lambda";
import * as lambda from 'aws-cdk-lib/aws-lambda';
new SnsToLambda(this, 'test-sns-lambda', {
lambdaFunctionProps: {
runtime: lambda.Runtime.NODEJS_16_X,
handler: 'index.handler',
code: lambda.Code.fromAsset(`lambda`)
}
});
Python
from aws_solutions_constructs.aws_sns_lambda import SnsToLambda
from aws_cdk import (
aws_lambda as _lambda,
Stack
)
from constructs import Construct
SnsToLambda(self, 'test_sns_lambda',
lambda_function_props=_lambda.FunctionProps(
code=_lambda.Code.from_asset('lambda'),
runtime=_lambda.Runtime.PYTHON_3_9,
handler='index.handler'
)
)
Java
import software.constructs.Construct;
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.awsconstructs.services.snslambda.*;
new SnsToLambda(this, "test-lambda-sqs-stack", new SnsToLambdaProps.Builder()
.lambdaFunctionProps(new FunctionProps.Builder()
.runtime(Runtime.NODEJS_16_X)
.code(Code.fromAsset("lambda"))
.handler("index.handler")
.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. |
existingTopicObj? | sns.Topic |
Existing instance of SNS Topic object, providing both this and topicProps will cause an error. |
topicProps? | sns.TopicProps |
Optional user provided properties to override the default properties for the SNS topic. |
enableEncryptionWithCustomerManagedKey? | boolean |
If no key is provided, this flag determines whether the SNS Topic is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: topicProps.masterKey, encryptionKey or encryptionKeyProps. |
encryptionKey? | kms.Key |
An optional, imported encryption key to encrypt the SNS Topic with. |
encryptionKeyProps? | kms.KeyProps |
Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SNS Topic with. |
Pattern Properties
Name | Type | Description |
---|---|---|
lambdaFunction | lambda.Function |
Returns an instance of the Lambda function created by the pattern. |
snsTopic | sns.Topic |
Returns an instance of the SNS topic created by the pattern. |
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
Amazon SNS Topic
- Configure least privilege access permissions for SNS Topic
- Enable server-side encryption for SNS Topic using AWS managed KMS Key
- Enforce encryption of data in transit
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 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for aws_solutions_constructs_aws_sns_lambda-2.72.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02df7189413e90290ef83e7beb06225aa93ad1b32dbb6648b4013165d0f3d6c6 |
|
MD5 | 6f1ef4dbe4d9452ec732b662d759773a |
|
BLAKE2b-256 | 4ee595965bfe13b23ca026c42e6b87478e2b048adf1535f2eb4bc456e900b999 |
Close
Hashes for aws_solutions_constructs.aws_sns_lambda-2.72.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41ec5a941a7601caa3270506088addf8f871c1b6eceba9220de50df5f539a92e |
|
MD5 | f4ce1efb26e896c59b9b970d128a42bd |
|
BLAKE2b-256 | 493786ce946abd605852447d57371a854ca521047ab0a64c142d1677748deb51 |