JSPM – @aws-solutions-constructs/aws-lambda-sns@1.55.0

Package Exports

@aws-solutions-constructs/aws-lambda-sns

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-solutions-constructs/aws-lambda-sns) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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_lambda_sns`
Typescript	`@aws-solutions-constructs/aws-lambda-sns`
Java	`software.amazon.awsconstructs.services.lambdasns`

This AWS Solutions Construct 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

scope Construct
id string
props LambdaToSnsProps

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	`lambda.Function`	Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored.
lambdaFunctionProps?	`lambda.FunctionProps`	User provided props to override the default props for the Lambda function.
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
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.
encryptionKey	`kms.Key`	Returns an instance of kms.Key used for the SNS topic.

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

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

Architecture Diagram

@aws-solutions-constructs/aws-lambda-sns