Skip to content

aws-sns-lambda module


Stability: Experimental

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.


Language Package
Python Logo Python aws_solutions_konstruk.aws_sns_lambda
Typescript Logo Typescript @aws-solutions-konstruk/aws-sns-lambda

This AWS Solutions Konstruk implements an Amazon SNS connected to an AWS Lambda function.

Here is a minimal deployable pattern definition:

const { SnsToLambdaProps, SnsToLambda } = require('@aws-solutions-konstruk/aws-sns-lambda');

const stack = new Stack(app, 'test-sns-lambda');

// Definitions
const props: SnsToLambdaProps = {
    deployLambda: true,
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_12_X,
        handler: 'index.handler',
        code: lambda.Code.asset(`${__dirname}/lambda`)
    }
};

new SnsToLambda(stack, 'test-sns-lambda', props);

Initializer

new SnsToLambda(scope: Construct, id: string, props: SnsToLambdaProps);

Parameters

Pattern Construct Props

Name Type Description
deployLambda boolean Whether to create a new Lambda function or use an existing Lambda function. If set to false, you must provide an existing function for the existingLambdaObj property.
existingLambdaObj? lambda.Function An optional, existing Lambda function. This property is required if deployLambda is set to false.
lambdaFunctionProps? lambda.FunctionProps Optional 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.

Architecture

Architecture Diagram


© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.