何をするか？
ここでは、CDK アプリとして作成した CloudFormation スタック内に、TypeScript で実装した Lambda 関数 を追加してみます。 Lambda 関数のビルドもデプロイ時に自動で行われるようにします。
以降の説明では、CDK プロジェクトの作成自体は済んでいるものとします。
TypeScript で Lambda 関数を実装する
Lambda 関数のコードは、プロジェクトのルートに lambda ディレクトリを作成して、そこに配置していくことにします。
myapp/
+-- bin/ ... CDK の App コンストラクト (.ts)
+-- lambda/ ... ラムダ関数の実装コード (.ts) ★これを追加
| +-- index.ts
+-- lib/ ... CDK の Stack コンストラクトなど (.ts)
...Lambda 関数実装用の TypeScript 型情報をインストールします。
$ npm install @types/aws-lambda --save-dev # npm の場合
$ yarn add @types/aws-lambda --dev # yarn の場合
最低限の Hello World 的なラムダ関数を作成します。
import { Handler } from "aws-lambda"
// Lambda エントリーポイント
export const handler: Handler = async () => {
console.log("Hello Lambda!")
}Lambda 関数を含むスタックの定義とデプロイ
NodejsFunction コンストラクト
AWS CDK が提供する NodejsFunction コンストラクトを使用すると、TypeScript 言語で実装した Lambda 関数を簡単にビルド＆デプロイできます。
- CDK V2 用の NodejsFunction コンストラクト (aws-cdk-lib/aws_lambda_nodejs)
- CDK V1 用の NodejsFunction コンストラクト (@aws-cdk/aws-lambda-nodejs)
Lambda 関数用の汎用的なコンストラクトとしては、aws-cdk-lib/aws_lambda が提供する Function コンストラクトがあるのですが、これの代わりに、Node.js (TypeScript) に特化した NodejsFunction の方を使うと、次のような恩恵を得られます。
- esbuild による Lambda 関数関連アセットの高速なパッケージング（バンドル）。
- Lambda 関数の TypeScript コードをいちいちコンパイルしなくてよい。
ちょっとややこしいのですが、（TypeScript で記述された）CDK コードの実行は ts-node で行われ、Lambda 関数のビルドとパッケージングは esbuild で行われるようになっています。
CDK V1 のコンストラクトパッケージは次のようにインストールします。
CDK V2 の場合は、aws-cdk-lib に含まれているので、追加でパッケージをインストールする必要はありません。
$ npm install @aws-cdk/aws-lambda-nodejs # npm の場合
$ yarn add @aws-cdk/aws-lambda-nodejs # yarn の場合
スタックの定義
CDK アプリのひな型として、CloudFormation スタックを構築するためのコンストラクト (lib/myapp-stack.ts) が生成されているはずなので、そのスタック内に、NodejsFunction コンストラクトを生成するよう記述します。
// CDK V1 の場合
// import { Construct, Stack, StackProps } from "@aws-cdk/core"
// import * as lambda from "@aws-cdk/aws-lambda-nodejs"
// CDK V2 の場合
import { Stack, StackProps, aws_lambda_nodejs as lambda } from "aws-cdk-lib"
import { Construct } from "constructs"
export class MyappStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props)
new lambda.NodejsFunction(this, "MyLambda", {
entry: "lambda/index.ts",
// handler: "handler", // デフォルトのハンドラ関数名は "handler"
// runtime: Runtime.NODEJS_14_X, // デフォルトは Node.js 14.x
// timeout: Duration.minutes(15), // デフォルトは 3 秒
})
}
}最小構成では、上記のように props オブジェクトの entry プロパティで Lambda 関数の index.ts ファイルパスを指定するだけで OK です。
デプロイ
スタックの定義が済んだら、cdk deploy を実行して Lambda 関数をデプロイすることができます。
$ npm run cdk -- deploy
デプロイが完了したら、CloudFormation コンソール を開いて、実際にスタックと Lambda 関数が生成されているか確認しましょう。 TypeScript コードのトランスパイルも esbuild で自動でやってくれるし、ZIP パッケージ化とアップロードも自動でやってくれる（これは CDK の機能ですが）ので、とっても楽ですね！
トラブルシューティング
デプロイ時に spawnSync docker ENOENT が出る場合
Windows や macOS で cdk diff や cdk deploy を実行したときに、spawnSync docker ENOENT というエラーが発生する場合は、esbuild をインストール するとうまくいくようです。
$ yarn add --dev esbuild@0
あるいは
$ npm install --save-dev esbuild@0
NodejsFunction の第1引数の this でエラーになるとき
CDK V1 の NodejsFunction のコンストラクタの this を渡している部分で、次のような型情報エラーが発生するときは、aws-cdk 本体と、コンストラクトライブラリ（@aws-cdk/aws-lambda-nodejs など）のバージョンが合っていない可能性があります。
Argument of type ’this’ is not assignable to parameter of type ‘Construct’. Type ‘MyappStack’ is not assignable to type ‘Construct’.
package.json を開いて、両者のバージョンを新しい方に揃えて、yarn install で更新すれば直ります。