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

Package Exports

@aws-solutions-constructs/aws-lambda-sns
@aws-solutions-constructs/aws-lambda-sns/lib/index.js

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

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 in Typescript:

import { LambdaToSns, LambdaToSnsProps } from "@aws-solutions-constructs/aws-lambda-sns";

new LambdaToSns(this, 'test-lambda-sns', {
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_14_X,
        handler: 'index.handler',
        code: lambda.Code.fromAsset(`${__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, 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.
existingVpc?	`ec2.IVpc`	An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for Amazon SQS. If an existing VPC is provided, the `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow clients to supply VPCs that exist outside the stack using the `ec2.Vpc.fromLookup()` method.
vpcProps?	`ec2.VpcProps`	Optional user-provided properties to override the default properties for the new VPC. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overrriden. If `deployVpc` is not `true` then this property will be ignored.
deployVpc?	`boolean`	Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern: One isolated subnet in each Availability Zone used by the CDK program `enableDnsHostnames` and `enableDnsSupport` will both be set to true If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`.
topicArnEnvironmentVariableName?	`string`	Optional Name for the SNS topic arn environment variable set for the Lambda function.
topicNameEnvironmentVariableName?	`string`	Optional Name for the SNS topic name environment variable set for the Lambda function.

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.
vpc?	`ec2.IVpc`	Returns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

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
- (default) SNS_TOPIC_NAME
- (default) SNS_TOPIC_ARN
- AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

Configure least privilege access permissions for SNS Topic
Enable server-side encryption forSNS Topic using AWS managed KMS Key
Enforce encryption of data in transit

Architecture

Architecture Diagram

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