@aws-solutions-konstruk/aws-cognito-apigateway-lam

aws-cognito-apigateway-lambda module

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
{: style="height:16px;width:16px"} Python	`aws_solutions_konstruk.aws_cognito_apigateway_lambda`
{: 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

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`	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

@aws-cdk/aws-lambda @aws-cdk/core @aws-cdk/aws-cognito @aws-cdk/aws-apigateway @aws-solutions-konstruk/core constructs

@infinitebrahmanuniverse/nolb-_aws-so @everything-registry/sub-chunk-103

0.8.1

4 years ago

0.8.0

4 years ago