aws-apigateway-ラムダ - AWS ソリューション構造

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

aws-apigateway-ラムダ

すべてのクラスは積極的に開発されており、将来のバージョンでは下位互換性がない変更または削除の対象となります。これらは、セマンティックバージョン管理モデル。つまり、これらのパッケージを使用するかもしれませんが、このパッケージの新しいバージョンにアップグレードするときにソースコードを更新する必要があるかもしれません。

注意: 正しく機能するためには、プロジェクト内の AWS ソリューション構築パッケージと AWS CDK パッケージが同じバージョンである必要があります。

言語 パッケージ
Python
aws_solutions_constructs.aws_apigateway_lambda
TypeScript
@aws-solutions-constructs/aws-apigateway-lambda
Java
software.amazon.awsconstructs.services.apigatewaylambda

Overview

この AWS ソリューション構築物は、AWS Lambda 関数に接続された Amazon API Gateway REST API を実装します。

TypeScript の最小限のデプロイ可能なパターン定義は次のとおりです。

import { ApiGatewayToLambda } from '@aws-solutions-constructs/aws-apigateway-lambda'; new ApiGatewayToLambda(this, 'ApiGatewayToLambdaPattern', { 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' } });

Initializer

new ApiGatewayToLambda(scope: Construct, id: string, props: ApiGatewayToLambdaProps);

パラメータ

パターン構成プロパティ

名前 タイプ 説明
ExistingLambdaObj? lambda.Function Lambda Functionオブジェクトの既存のインスタンス。これとlambdaFunctionPropsはエラーを発生させます。
LambdaFunctionProps? lambda.FunctionProps Lambda 関数のデフォルトプロパティを上書きするオプションのユーザー指定のプロパティ。の場合は無視されます。existingLambdaObjが提供される。
ApigateWayProps? api.LambdaRestApiProps オプションのユーザ提供の小道具で、API のデフォルトの小道具をオーバーライドします。
LogGroupPropsかな? logs.LogGroupProps CloudWatch Logs ロググループのデフォルト小道具を上書きする、オプションのユーザー提供の小道具です。

パターンプロパティ

名前 タイプ 説明
APIGatewayクラウドウォッチロール iam.Role API Gateway REST API から CloudWatch へのアクセスロギングを有効にするパターンによって作成された IAM ロールのインスタンスを返します。
APIGateWayLogGroup logs.LogGroup API Gateway REST API アクセスログが送信されるパターンによって作成されたロググループのインスタンスを返します。
LambdaFunction lambda.Function パターンによって作成された Lambda 関数のインスタンスを返します。
apigateway api.LambdaRestApi パターンによって作成された API Gateway REST API のインスタンスを返します。

デフォルト設定

オーバーライドなしでこのパターンをすぐに実装すると、次のデフォルトが設定されます。

Amazon API Gateway

  • エッジ最適化 API エンドポイントのデプロイ

  • API Gateway での CloudWatch によるロギングの有効化

  • API Gateway の最小権限アクセス IAM ロールを設定する

  • すべての API メソッドのデフォルトの認証タイプを IAM に設定する

  • X-Ray トレースを有効にする

  • 環境変数の設定:

    • AWS_NODEJS_CONNECTION_REUSE_ENABLED(ノード10.x以上の機能の場合)

AWS Lambda 関数

  • Lambda 関数の制限付き特権アクセス IAM ロールを設定する

  • NodeJS Lambda 関数のキープアライブを使用して接続を再利用できるようにする

  • X-Ray トレースを有効にする

Architecture

GitHub

このパターンのコードを表示するには、問題を作成/表示し、プル要求などを行います。
@aws-solutions-constructions/aws-apigateway-lambda