Skip to main content

CDK constructs for defining an interaction between an API Gateway and a Lambda function.

Project description

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.

Project details


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-apigateway-lambda, version 0.8.1
Filename, size File type Python version Upload date Hashes
Filename, size aws_solutions_konstruk.aws_apigateway_lambda-0.8.1-py3-none-any.whl (124.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size aws-solutions-konstruk.aws-apigateway-lambda-0.8.1.tar.gz (125.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page