Skip to main content

CDK Constructs for AWS Cognito to AWS API Gateway to AWS Lambda integration

Project description

aws-cognito-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:
Language Package
Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_cognito_apigateway_lambda
Typescript Logo{: style="height:16px;width:16px"} Typescript @aws-solutions-konstruk/aws-cognito-apigateway-lambda

This AWS Solutions Konstruk implements an Amazon Cognito securing an Amazon API Gateway Lambda backed REST APIs pattern.

Here is a minimal deployable pattern definition:

const { CognitoToApiGatewayToLambda } = require('@aws-solutions-konstruk/aws-cognito-apigateway-lambda');

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

const lambdaProps: lambda.FunctionProps = {
    code: lambda.Code.asset(`${__dirname}/lambda`),
    runtime: lambda.Runtime.NODEJS_12_X,
    handler: 'index.handler'

new CognitoToApiGatewayToLambda(stack, 'test-cognito-apigateway-lambda', {
    lambdaFunctionProps: lambdaProps,
    deployLambda: true


new CognitoToApiGatewayToLambda(scope: Construct, id: string, props: CognitoToApiGatewayToLambdaProps);


Pattern Construct Props

Name Type Description
deployLambda boolean Whether to create a new Lambda function or use an existing Lambda function
existingLambdaObj? lambda.Function Existing instance of Lambda Function object
lambdaFunctionProps? lambda.FunctionProps Optional user provided props to override the default props for Lambda function
apiGatewayProps? api.LambdaRestApiProps Optional user provided props to override the default props for API Gateway
cognitoUserPoolProps? cognito.UserPoolProps Optional user provided props to override the default props for Cognito User Pool
cognitoUserPoolClientProps? cognito.UserPoolClientProps Optional user provided props to override the default props for Cognito User Pool Client

Pattern Properties

Name Type Description
restApi() api.RestApi Retruns an instance of api.RestApi created by the construct
lambdaFunction() lambda.Function Retruns an instance of lambda.Function created by the construct
userPool() cognito.UserPool Retruns an instance of cognito.UserPool created by the construct
userPoolClient() cognito.UserPoolClient Retruns an instance of cognito.UserPoolClient created by the construct


Architecture Diagram

© Copyright 2020, 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, version 0.8.0
Filename, size File type Python version Upload date Hashes
Filename, size aws_solutions_konstruk.aws_cognito_apigateway_lambda-0.8.0-py3-none-any.whl (108.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size (109.1 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