TypeScript Lambda Function

Filter this guidePick generator option values to hide sections that don't apply.

event

TypeScript Lambda Function ジェネレーターは、既存の TypeScript プロジェクトに lambda 関数を追加する機能を提供します。

このジェネレーターは、AWS CDK または Terraform インフラストラクチャセットアップを使用して、新しい TypeScript lambda ハンドラーを作成します。生成されたハンドラーは、ログ記録、AWS X-Ray トレーシング、CloudWatch メトリクスを含む可観測性のために AWS Lambda Powertools for TypeScript を使用し、さらに AWS Lambda Powertools の Parser を使用したイベントのオプションの型安全性も提供します。

使用方法

TypeScript lambda 関数を生成する

lambda 関数は 2 つの方法で生成できます:

CLI
VSCode

pnpm nx g @aws/nx-plugin:ts#lambda-function

yarn nx g @aws/nx-plugin:ts#lambda-function

npx nx g @aws/nx-plugin:ts#lambda-function

bunx nx g @aws/nx-plugin:ts#lambda-function

変更されるファイルを確認するためにドライランを実行することもできます

pnpm nx g @aws/nx-plugin:ts#lambda-function --dry-run

yarn nx g @aws/nx-plugin:ts#lambda-function --dry-run

npx nx g @aws/nx-plugin:ts#lambda-function --dry-run

bunx nx g @aws/nx-plugin:ts#lambda-function --dry-run

インストール Nx Console VSCode Plugin まだインストールしていない場合
VSCodeでNxコンソールを開く
クリック Generate (UI) "Common Nx Commands"セクションで
検索 @aws/nx-plugin - ts#lambda-function
必須パラメータを入力
クリック Generate

オプション

パラメータ	型	デフォルト	説明
project 必須	string	-	Lambda関数を追加するプロジェクト
name 必須	string	-	追加する関数の名前
functionPath	string	-	関数を追加するプロジェクトソースディレクトリ内のオプションのサブディレクトリ
event	Any \| AlbSchema \| APIGatewayProxyEventSchema \| APIGatewayRequestAuthorizerEventSchema \| APIGatewayTokenAuthorizerEventSchema \| APIGatewayProxyEventV2Schema \| APIGatewayProxyWebsocketEventSchema \| APIGatewayRequestAuthorizerEventV2Schema \| CloudFormationCustomResourceCreateSchema \| CloudFormationCustomResourceUpdateSchema \| CloudFormationCustomResourceDeleteSchema \| CloudWatchLogsSchema \| PreSignupTriggerSchema \| PostConfirmationTriggerSchema \| CustomMessageTriggerSchema \| MigrateUserTriggerSchema \| CustomSMSSenderTriggerSchema \| CustomEmailSenderTriggerSchema \| DefineAuthChallengeTriggerSchema \| CreateAuthChallengeTriggerSchema \| VerifyAuthChallengeTriggerSchema \| PreTokenGenerationTriggerSchemaV1 \| PreTokenGenerationTriggerSchemaV2AndV3 \| DynamoDBStreamSchema \| EventBridgeSchema \| KafkaMskEventSchema \| KafkaSelfManagedEventSchema \| KinesisDataStreamSchema \| KinesisFirehoseSchema \| KinesisDynamoDBStreamSchema \| KinesisFirehoseSqsSchema \| LambdaFunctionUrlSchema \| S3EventNotificationEventBridgeSchema \| S3Schema \| S3ObjectLambdaEventSchema \| S3SqsEventNotificationSchema \| SesSchema \| SnsSchema \| SqsSchema \| TransferFamilySchema \| VpcLatticeSchema \| VpcLatticeV2Schema	Any	Lambda関数に使用するオプションのイベントソーススキーマ
infra	lambda \| none	lambda	Lambda関数をデプロイするインフラストラクチャのタイプ
iac	inherit \| cdk \| terraform	inherit	優先するIaCプロバイダー。デフォルトでは初期選択から継承されます。
preferInstallDependencies	boolean	true	ジェネレーター実行後に依存関係のインストールを優先するかどうか。複数のジェネレーターをバッチ処理する際にインストールを延期する場合はfalseに設定します（後続のジェネレーターがNxプロジェクトグラフを計算できるよう、必要に応じてインストールは実行されます）。最後に一度だけインストールします。

ジェネレーターの出力

ジェネレーターは、プロジェクトに以下のファイルを追加します:

Directory<project-name>
- Directorysrc/
  - <lambda-function>.ts Function implementation

functionPath オプションが指定されている場合、ジェネレーターはプロジェクトのソースディレクトリ内の指定されたパスにハンドラーを追加します:

Directory<project-name>
- Directorysrc/
  - Directory<custom-path>/
    <function-name>.ts Function implementation

インフラストラクチャ

このジェネレーターは、選択した iac に基づいてインフラストラクチャをコードとして提供するため、関連する CDK コンストラクトまたは Terraform モジュールを含む packages/common にプロジェクトを作成します。

共通のインフラストラクチャコードプロジェクトは、次のように構成されています：

CDK
Terraform

Directorypackages/common/constructs
- Directorysrc
  - Directoryapp/ プロジェクト/ジェネレーター固有のインフラストラクチャ用のコンストラクト
    …
  - Directorycore/ app 内のコンストラクトによって再利用される汎用コンストラクト
    …
  - index.ts app からコンストラクトをエクスポートするエントリーポイント
- project.json プロジェクトのビルドターゲットと設定

Directorypackages/common/terraform
- Directorysrc
  - Directoryapp/ プロジェクト/ジェネレーター固有のインフラストラクチャ用の Terraform モジュール
    …
  - Directorycore/ app 内のモジュールによって再利用される汎用モジュール
    …
- project.json プロジェクトのビルドターゲットと設定

ジェネレーターは、選択した iac に基づいて関数をデプロイするための Infrastructure as Code を作成します:

CDK
Terraform

ジェネレーターは、関数をデプロイするために使用できる CDK コンストラクトを作成します。これは packages/common/constructs/src/app/lambda-functions ディレクトリに配置されます。

ジェネレーターは、関数をデプロイするために使用できる Terraform モジュールを作成します。これは packages/common/terraform/src/app/lambda-functions/<function-name> ディレクトリに配置されます。

アーキテクチャ

デプロイされた関数は以下のアーキテクチャを持ちます：

ジェネレーターは関数自体を提供します。イベントソースを呼び出すためにスタック内で接続します（例：API Gateway 統合、EventBridge ルール、S3 通知、または SQS イベントソースマッピング）。

関数の実装

メインの関数実装は <function-name>.ts にあります。以下は例です:

import { parser } from '@aws-lambda-powertools/parser/middleware';
import { EventBridgeSchema } from '@aws-lambda-powertools/parser/schemas';
import middy from '@middy/core';
import { Tracer } from '@aws-lambda-powertools/tracer';
import { captureLambdaHandler } from '@aws-lambda-powertools/tracer/middleware';
import { injectLambdaContext } from '@aws-lambda-powertools/logger/middleware';
import { Logger } from '@aws-lambda-powertools/logger';
import { Metrics } from '@aws-lambda-powertools/metrics';
import { logMetrics } from '@aws-lambda-powertools/metrics/middleware';
import { z } from 'zod';

process.env.POWERTOOLS_METRICS_NAMESPACE = 'MyFunction';
process.env.POWERTOOLS_SERVICE_NAME = 'MyFunction';

const tracer = new Tracer();
const logger = new Logger();
const metrics = new Metrics();

export const myFunction = async (
  event: z.infer<typeof EventBridgeSchema>,
): Promise<void> => {
  logger.info('Received event', event);

  // TODO: implement
};

export const handler = middy()
  .use(captureLambdaHandler(tracer))
  .use(injectLambdaContext(logger))
  .use(logMetrics(metrics))
  .use(parser({ schema: EventBridgeSchema }))
  .handler(myFunction);

ジェネレーターは、いくつかの機能を自動的にセットアップします:

Middy ミドルウェアスタック - 拡張された Lambda 機能のため
AWS Lambda Powertools 統合 - 可観測性のため
メトリクス収集 - CloudWatch を使用
型安全性 - parser ミドルウェアを使用
Rolldown によるバンドル - 最適化されたデプロイパッケージのため

AWS Lambda Powertools による可観測性

ログ記録

ジェネレーターは、Middy ミドルウェアを介した自動コンテキスト注入を使用して、AWS Lambda Powertools を使用した構造化ログを設定します。

export const handler = middy()
  .use(injectLambdaContext(logger))
  .handler(myFunction);

トレーシング

AWS X-Ray トレーシングは、captureLambdaHandler ミドルウェアを介して自動的に設定されます。トレースにカスタムサブセグメントを追加できます:

const tracer = new Tracer();

export const myFunction = async (
  event: z.infer<typeof EventBridgeSchema>,
): Promise<void> => {
  // Creates a new subsegment
  const subsegment = tracer.getSegment()?.addNewSubsegment('custom-operation');
  try {
    // Your logic here
  } catch (error) {
    subsegment?.addError(error as Error);
    throw error;
  } finally {
    subsegment?.close();
  }
};

export const handler = middy()
  .use(captureLambdaHandler(tracer))
  .handler(myFunction);

メトリクス

CloudWatch メトリクスは、logMetrics ミドルウェアを介して各リクエストに対して自動的に収集されます。カスタムメトリクスを追加できます:

const metrics = new Metrics();

export const myFunction = async (
  event: z.infer<typeof EventBridgeSchema>,
): Promise<void> => {
  metrics.addMetric("CustomMetric", MetricUnit.Count, 1);
  metrics.addMetric("ProcessingTime", MetricUnit.Milliseconds, processingTime);
};

export const handler = middy()
  .use(logMetrics(metrics))
  .handler(myFunction);

型安全性

lambda 関数を生成する際に event を選択した場合、関数は AWS Lambda Powertools の parser ミドルウェアでインストルメント化されます。例:

export const myFunction = async (
  event: z.infer<typeof EventBridgeSchema>,
): Promise<void> => {
  event.detail // <- type-safe with IDE autocompletion
};

export const handler = middy()
  .use(parser({ schema: EventBridgeSchema }))
  .handler(myFunction);

これにより、Lambda イベントのコンパイル時の型安全性とランタイム検証が提供されます。

event に Any を選択した場合、parser ミドルウェアは組み込まれず、event パラメータは any として型付けされます。コンパイル時の型安全性とランタイム検証が必要な場合は、特定の event を指定して関数を再生成してください。

バンドル

ジェネレーターは、Rolldown を使用してデプロイメントパッケージを作成する bundle ターゲットを自動的に設定します：

pnpm nx bundle <project-name>

yarn nx bundle <project-name>

npx nx bundle <project-name>

bunx nx bundle <project-name>

Rolldown の設定は rolldown.config.ts にあり、生成するバンドルごとにエントリーがあります。Rolldown は、定義されている場合、複数のバンドルを並列で作成することを管理します。

関数のデプロイ

このジェネレーターは、選択した iac に基づいて CDK または Terraform のインフラストラクチャコードを作成します。これを使用して関数をデプロイできます。

CDK
Terraform

このジェネレーターは、common/constructs フォルダに関数をデプロイするための CDK コンストラクトを作成します。これを CDK アプリケーションで使用できます：

import { MyProjectMyFunction } from '@my-scope/common-constructs';

export class ExampleStack extends Stack {
  constructor(scope: Construct, id: string) {
    // Add the function to your stack
    const fn = new MyProjectMyFunction(this, 'MyFunction');
  }
}

これにより以下が設定されます：

AWS Lambda 関数
CloudWatch ロググループ
X-Ray トレース設定
CloudWatch メトリクス名前空間

この関数は、任意の Lambda イベントソースのターゲットとして使用できます：

以下の例は、EventBridge を使用してスケジュールに従って Lambda 関数を呼び出すための CDK コードを示しています：

import { Rule, Schedule } from 'aws-cdk-lib/aws-events';
import { LambdaFunction } from 'aws-cdk-lib/aws-events-targets';
import { MyProjectMyFunction } from '@my-scope/common-constructs';

export class ExampleStack extends Stack {
  constructor(scope: Construct, id: string) {
    // Add the function to your stack
    const fn = new MyProjectMyFunction(this, 'MyFunction');

    // Add the function to an EventBridge scheduled rule
    const eventRule = new Rule(this, 'MyFunctionScheduleRule', {
      schedule: Schedule.cron({ minute: '15' }),
      targets: [new LambdaFunction(fn)],
    });
  }
}

このジェネレーターは、common/terraform フォルダに関数をデプロイするための Terraform モジュールを作成します。デプロイごとに共有 core/asset-bucket モジュールを一度インスタンス化し、その bucket_name を asset_bucket_name 入力に渡します：

module "asset_bucket" {
  source = "../../common/terraform/src/core/asset-bucket"
}

module "my_project_my_function" {
  source = "../../common/terraform/src/app/lambda-functions/my-project-my-function"

  asset_bucket_name = module.asset_bucket.bucket_name

  env = {
    SOME_VARIABLE = "some value"
  }

  additional_iam_policy_statements = [
    # Add any additional permissions your function needs
  ]
}

これにより以下が設定されます：

AWS Lambda 関数
CloudWatch ロググループ
X-Ray トレース設定
CloudWatch メトリクス名前空間

この関数は、任意の Lambda イベントソースのターゲットとして使用できます。以下の例は、EventBridge を使用してスケジュールに従って Lambda 関数を呼び出すための Terraform コードを示しています：

# EventBridge rule for scheduled execution
resource "aws_cloudwatch_event_rule" "my_function_schedule" {
  name                = "my-function-schedule"
  description         = "Trigger my function every 15 minutes"
  schedule_expression = "cron(15 * * * ? *)"
}

# EventBridge target
resource "aws_cloudwatch_event_target" "lambda_target" {
  rule      = aws_cloudwatch_event_rule.my_function_schedule.name
  target_id = "MyFunctionTarget"
  arn       = module.my_project_my_function.function_arn
}

# Permission for EventBridge to invoke the Lambda function
resource "aws_lambda_permission" "allow_eventbridge" {
  statement_id  = "AllowExecutionFromEventBridge"
  action        = "lambda:InvokeFunction"
  function_name = module.my_project_my_function.function_name
  principal     = "events.amazonaws.com"
  source_arn    = aws_cloudwatch_event_rule.my_function_schedule.arn
}