aws-cognito-apigateway-lambda

Toutes les classes sont en cours de développement actif et sujettes à des modifications ou à des suppressions non rétrocompatibles dans toute version future. Ceux-ci ne sont pas assujettis à laGestion sémantique des versionsModèle. Cela signifie que même si vous pouvez les utiliser, vous devrez peut-être mettre à jour votre code source lors de la mise à niveau vers une version plus récente de ce package.

Remarque: Pour garantir une bonne fonctionnalité, les packages AWS Solutions Constructs et AWS CDK de votre projet doivent être la même version.

Langage	Package
Python	aws_solutions_constructs.aws_cognito_apigateway_lambda
TypeScript	@aws-solutions-constructs/aws-cognito-apigateway-lambda
Java	software.amazon.awsconstructs.services.cognitoapigatewaylambda

Overview

Cette solution AWS Construct implémente Amazon Cognito sécurise une API REST basée sur Amazon API Gateway Lambda.

Voici une définition de modèle déployable minimale dans TypeScript :

import { CognitoToApiGatewayToLambda } from '@aws-solutions-constructs/aws-cognito-apigateway-lambda';

new CognitoToApiGatewayToLambda(this, 'test-cognito-apigateway-lambda', {
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_14_X,
        // This assumes a handler function in lib/lambda/index.js
        code: lambda.Code.fromAsset(`${__dirname}/lambda`),
        handler: 'index.handler'
    }
});

Si vous définissez des ressources et des méthodes sur votre API (par exempleproxy = false), vous devez appeler leaddAuthorizers()après que l'API est complètement définie. Cela garantit que toutes les méthodes de votre API sont protégées.

Voici un exemple de TypeScript :

import { CognitoToApiGatewayToLambda } from '@aws-solutions-constructs/aws-cognito-apigateway-lambda';

const construct = new CognitoToApiGatewayToLambda(this, 'test-cognito-apigateway-lambda', {
    lambdaFunctionProps: {
        // This assumes a handler function in lib/lambda/index.js
        code: lambda.Code.fromAsset(`${__dirname}/lambda`),
        runtime: lambda.Runtime.NODEJS_12_X,
        handler: 'index.handler'
    },
    apiGatewayProps: {
      proxy: false
    }
});

const resource = construct.apiGateway.root.addResource('foobar');
resource.addMethod('POST');

// Mandatory to call this method to Apply the Cognito Authorizers on all API methods
construct.addAuthorizers();

Initializer

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

Paramètres

• scopeConstruct

• idstring

• propsCognitoToApiGatewayToLambdaProps

Props de construction de modèle

Nom	Type	Description
L'existence de Glambdaobj ?	lambda.Function	Instance existante de l'objet Lambda Function, fournissant à la fois ceci etlambdaFunctionPropsprovoquera une erreur.
LambdaFunctionProps ?	lambda.FunctionProps	Propriétés facultatives fournies par l'utilisateur pour remplacer les propriétés par défaut de la fonction Lambda. Ignoré si unexistingLambdaObjest fourni.
ApigatewayProps ?	api.LambdaRestApiProps	Props fournis par l'utilisateur en option pour remplacer les accessoires par défaut pour API Gateway
CognitouserPoolProps ?	cognito.UserPoolProps	Props fournis par l'utilisateur en option pour remplacer les accessoires par défaut pour le pool d'utilisateurs Cognito
CognitouserPoolClientProps ?	cognito.UserPoolClientProps	Props fournis par l'utilisateur en option pour remplacer les accessoires par défaut pour Cognito User Pool Client
LogGroupProps ?	logs.LogGroupProps	Props fournis par l'utilisateur en option pour remplacer les accessoires par défaut pour le groupe de journaux CloudWatch Logs.

Propriétés de modèle

Nom	Type	Description
Apigateway	api.RestApi	Renvoie une instance de l'API Gateway API créée par le modèle.
LambdaFunction	lambda.Function	Renvoie une instance de la fonction Lambda créée par le modèle.
userPool	cognito.UserPool	Renvoie une instance du pool d'utilisateurs Cognito créé par le modèle.
UserPoolClient	cognito.UserPoolClient	Renvoie une instance du client de pool d'utilisateurs Cognito créé par le modèle.
ApigateWayCloudWatchRole	iam.Role	Renvoie une instance du rôle IAM créé par le modèle qui active la journalisation des accès à partir de l'API Gateway API vers CloudWatch.
ApigateWayLogGroup	logs.LogGroup	Renvoie une instance du groupe de journaux créé par le modèle auquel les journaux d'accès API REST de API Gateway d'API sont envoyés.
ApigatewayAuthorizer	api.CfnAuthorizer	Renvoie une instance de l'autorisation API Gateway créée par le modèle.

Paramètres par défaut

L'implémentation prête à l'emploi de ce modèle sans remplacement définira les valeurs par défaut suivantes :

Amazon Cognito

• Définition d'une stratégie de mot de passe pour les groupes

• Appliquer le mode de sécurité avancé pour les pools d'utilisateurs

Amazon API Gateway

• Déployer un point de terminaison API optimisé pour les périphériques

• Activer la journalisation CloudWatch pour API Gateway

• Configurer le rôle IAM d'accès minimal aux privilèges pour API Gateway

• Définissez l'AuthorizationType par défaut pour toutes les méthodes d'API sur IAM

• Activer le suivi X-Ray

Fonction AWS Lambda

• Configuration du rôle IAM d'accès limité pour la fonction Lambda

• Activer la réutilisation des connexions avec la fonction Keep-Alive pour NodeJS Lambda

• Activer le suivi X-Ray

• Définir les variables d'environnement :

  • AWS_NODEJS_CONNECTION_REUSE_ENABLED(pour les fonctions Nœud 10.x et supérieures)

Architecture

GitHub

Pour afficher le code de ce modèle, créer/afficher les problèmes et les demandes d'extraction, et plus encore :
	@aws -solutions-construction/aws-cognito-apigateway-lambda