Narwhal Parade Maestro

    @aws-solutions-konstruk/aws-lambda-sns
    TypeScript icon, indicating that this package has built-in type declarations

    0.8.1 • Public • Published

    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.

    Keywords

    none

    Install

    npm i @aws-solutions-konstruk/aws-lambda-sns

    DownloadsWeekly Downloads

    4

    Version

    0.8.1

    License

    Apache-2.0

    Unpacked Size

    195 kB

    Total Files

    17

    Last publish

    Collaborators

    • aws-solutions-konstruk-support