Skip to main content

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: http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-cognito-apigateway-lambda/
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
});

Initializer

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

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 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 Returns an instance of api.RestApi created by the construct
lambdaFunction() lambda.Function Returns an instance of lambda.Function created by the construct
userPool() cognito.UserPool Returns an instance of cognito.UserPool created by the construct
userPoolClient() cognito.UserPoolClient Returns an instance of cognito.UserPoolClient created by the construct

Architecture

Architecture Diagram


© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Release files for aws-solutions-konstruk.aws-cognito-apigateway-lambda 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-solutions-konstruk.aws-cognito-apigateway-lambda 0.8.1
File Size Uploaded
aws-solutions-konstruk.aws-cognito-apigateway-lambda-0.8.1.tar.gz 110.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aws-solutions-konstruk.aws-cognito-apigateway-lambda 0.8.1
File Interpreter ABI Platform
aws_solutions_konstruk.aws_cognito_apigateway_lambda-0.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 219.7 kB

Release files / aws-solutions-konstruk.aws-cognito-apigateway-lambda-0.8.1.tar.gz

Download URL aws-solutions-konstruk.aws-cognito-apigateway-lambda-0.8.1.tar.gz
Size 110.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f4d7ef438d0d0528b79dfb88b2d72154b294e1cb18e7ebfcab5f3a4587c358b1
BLAKE2b-256 checksum
How to use checksums
bd8563fa8eeb8eabe4703c97b2a79fd3c7f8b50133c551bc5128b8b4c9b55d80
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

Release files / aws_solutions_konstruk.aws_cognito_apigateway_lambda-0.8.1-py3-none-any.whl

Download URL aws_solutions_konstruk.aws_cognito_apigateway_lambda-0.8.1-py3-none-any.whl
Size 109.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a880367ed1060dc55472753499da525d5b460bcfa0bcdc7e1f8204a44d350ff6
BLAKE2b-256 checksum
How to use checksums
203e7fc669e65c865346e274bb8b1bc3a59f49852663c09404c63e5a70cff28e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 release files

0.8.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page