aws-lambda-sns - AWS Solutions Constructs

aws-lambda-sns

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.

Language Package
Python
aws_solutions_constructs.aws_lambda_sns
Typescript
@aws-solutions-constructs/aws-lambda-sns
Java
software.amazon.awsconstructs.services.lambdasns

This AWS Solutions Constructs pattern implements an AWS Lambda function connected to an Amazon SNS topic.

Here is a minimal deployable pattern definition:

const { LambdaToSns } = require('@aws-solutions-constructs/aws-lambda-sns'); new LambdaToSns(stack, 'LambdaToSnsPattern', { lambdaFunctionProps: { runtime: lambda.Runtime.NODEJS_10_X, handler: 'index.handler', code: lambda.Code.asset(`${__dirname}/lambda`) } });

Initializer

new LambdaToSns(scope: Construct, id: string, props: LambdaToSnsProps);

Parameters

Pattern Construct Props

Name Type Description
existingLambdaObj? lambda.Function An optional, existing Lambda function to be used instead of the default function. If an existing function is provided, the lambdaFunctionProps property will be ignored.
lambdaFunctionProps? lambda.FunctionProps Optional user-provided properties to override the default properties for the Lambda function. Ignored if an existingLambdaObj is provided.
topicProps? sns.TopicProps Optional user provided properties to override the default properties for the SNS topic.
enableEncryption? boolean Use a KMS Key, either managed by this CDK app, or imported. If importing an encryption key, it must be specified in the encryptionKey property for this construct.
encryptionKey? kms.Key An optional, imported encryption key to encrypt the SNS topic with.

Pattern Properties

Name Type Description
encryptionKey kms.Key Returns an instance of the encryption key created by the pattern.
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:

AWS Lambda Function

  • Configure least privilege access IAM role for Lambda function

  • Enable reusing connections with Keep-Alive for NodeJs Lambda function

Amazon SNS Topic

  • Configure least privilege access permissions for SNS Topic

  • Enable server-side encryption forSNS Topic using Customer managed KMS Key

  • Enforce encryption of data in transit

Architecture