Skip to main content

CDK constructs for defining an interaction between an AWS Lambda function and an Amazon SNS topic.

Project description

aws-lambda-sns 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.


API Reference: http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-lambda-sns/
Language Package
Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_lambda_sns
Typescript Logo{: style="height:16px;width:16px"} Typescript @aws-solutions-konstruk/aws-lambda-sns

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

Here is a minimal deployable pattern definition:

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

new LambdaToSns(stack, 'LambdaToSnsPattern', {
    deployLambda: true,
    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
deployLambda boolean Whether to create a new Lambda function or use an existing Lambda function.
existingLambdaObj? lambda.Function An optional, existing Lambda function.
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.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aws-solutions-konstruk.aws-lambda-sns, version 0.8.0
Filename, size File type Python version Upload date Hashes
Filename, size aws_solutions_konstruk.aws_lambda_sns-0.8.0-py3-none-any.whl (93.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size aws-solutions-konstruk.aws-lambda-sns-0.8.0.tar.gz (94.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page