Node Packaged Masterfully

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

    0.8.1 • Public • Published

    aws-apigateway-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.


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

    Overview

    This AWS Solutions Konstruk implements an Amazon API Gateway REST API connected to an AWS Lambda function pattern.

    Here is a minimal deployable pattern definition:

    const { ApiGatewayToLambda } = require('@aws-solutions-konstruk/aws-apigateway-lambda');
    
    new ApiGatewayToLambda(stack, 'ApiGatewayToLambdaPattern', {
        deployLambda: true,
        lambdaFunctionProps: {
            runtime: lambda.Runtime.NODEJS_10_X,
            handler: 'index.handler',
            code: lambda.Code.asset(`${__dirname}/lambda`)
        }
    });

    Initializer

    new ApiGatewayToLambda(scope: Construct, id: string, props: ApiGatewayToLambdaProps);
    

    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. This property is only required if deployLambda is set to true.
    apiGatewayProps? api.LambdaRestApiProps Optional user-provided props to override the default props for the API.

    Pattern Properties

    Name Type Description
    lambdaFunction() lambda.Function Returns an instance of the Lambda function created by the pattern.
    restApi() api.LambdaRestApi Returns an instance of the API Gateway REST API 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-apigateway-lambda

    DownloadsWeekly Downloads

    2

    Version

    0.8.1

    License

    Apache-2.0

    Unpacked Size

    294 kB

    Total Files

    17

    Last publish

    Collaborators

    • aws-solutions-konstruk-support