LambdaバージョンをAWS CDKで構築する際にハマったエラー #AWS

概要

Lambda functionとそのバージョンの発行をAWS CDKにて構築する際に「Lambdaコード更新と発行されるバージョン番号の関係」を正しく理解できず、エラーに悩みました。

そこで、AWS CDKでLambda functionとそのバージョンを発行する場合の挙動について検証しました。

本記事では、これらの検証結果とその解説を記述しています。

サンプルコード

以下GitHubにて公開しています。

YoshinoriSatoh/o-aws-lambda-version-cdk

Lambda Version

Lambda versionについては、以下参考記事でも説明されています。

https://qiita.com/quotto/items/4c364074edc69cb67d70

また、公式ドキュメントは以下です。

https://docs.aws.amazon.com/ja_jp/lambda/latest/dg/configuration-versions.html

要点

先に要点を記述します。

Lambda functionには、常に最新バージョン=$LATEST が存在する
Lambda functionコードを更新すると、$LATEST も合わせて更新される
新規バージョンを発行すると、その内容は $LATEST のものとなる
新規バージョンは、"$LATEST" と "最後に発行されたバージョン" との間でコード差分がある場合のみ発行できる
バージョン番号は 1 から始まり、新規バージョン発行時にインクリメントされていく

上記を図示すると以下のイメージです。

AWSコンソールから操作時の検証

理解のし易さのため、先にAWSコンソールから手動でLambda functionを作成し、バージョン発行する際の挙動を見てみます。

手動で作成直後のLambda function です。

最新バージョンである "$LATEST" だけがバージョンとして存在しています。

画像では作成してからスクショを撮るまでに時間が空いてしまったため、$LATESTの最終更新日時は2時間前となっています。

関数コードを変更して「保存」します。

exports.handler = async (event) => {
    // TODO implement
    const response = {
        statusCode: 200,
        body: JSON.stringify('Change 1'), <-- 変更
    };
    return response;
};

$LATESTの更新時刻が更新されました。

バージョンを発行してみます。

バージョン１が発行されました。

コードを変更せず、さらに新しいバージョンを発行しようとすると怒られます。

「"$LATEST" と "最後に発行されたバージョン"との間でコード差分がない」ためです。

この状態で、コードを変更して「保存」してみます。

$LATESTの更新時刻が更新されています。

これで、「"$LATEST" と "最後に発行されたバージョン"との間でコード差分がある」状態になりました。

新しいバージョンを発行できます。

Lambda function versionの挙動は、概ね以上のようになります。

AWSコンソールからやってみると、全く難しい概念ではないということがわかると思います。

CDKによる構築

CDKを使用する場合でも、上記までのことを正しく理解していれば迷うことなく構築できるはずです。

CDKコードとその挙動

関数コードに変更がある度にバージョンを発行するCDKコードとその挙動を紹介します。

export class OAwsLambdaVersionCdkStack extends cdk.Stack {
  constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const codePath = path.join(__dirname, 'functions/api');
    const fn = new lambda.Function(this, 'CdkLambdaFunction', {
      functionName: `cdk-lambda-function`,
      runtime: lambda.Runtime.NODEJS_12_X,
      handler: 'index.handler',
      code: lambda.Code.fromAsset(codePath),
    });
    fn.addVersion(sha256(`${codePath}/index.js`)); // <-- この行で新バージョンを発行
  }
}

上記のCDKコードをデプロイすると、以下のように、Lambda functionとそのバージョン１が作成されます。

2回目以降のデプロイでは、

「lambda functionコードの内容に変更があった場合にのみ、新しいバージョンを発行する」という動作になります。

関数コードを変更して再度デプロイしてみます。

関数コードの変更により$LATESTが更新され、更に$LATESTが"最後に発行されたバージョン"であるバージョン1と差分がある状態になったため、新しいバージョンが発行されています。

バージョン発行部分の解説

さて、lambda functionのバージョンを発行する部分ですが、以下のような記述をしています。

fn.addVersion(sha256(`${codePath}/index.js`)); // <-- この行で新バージョンを発行

API ReferenceからaddVersionの仕様を確認すると、第一引数(必須)には一意の識別子を指定する必要があります。

「バージョン番号を指定」ではなく、「バージョンに紐づく一意の識別子」を指定です。

上記では「関数コードのSHA256ハッシュ値」を指定することで、関数コードの内容に応じて異なり、かつ関数コードに紐づく識別子を生成しています。

この指定によって「関数コードを変更する度に新バージョンを発行する」という挙動となります。

バージョン識別子を個別に指定する場合に発生する可能性があるエラー

必ずしも関数コードの変更に応じてバージョンを発行したい場合だけではないと思います。

しかし、addVersionに指定する識別子を個別に設定する場合、気をつけていないと、以下２パターンのエラーが起こり得ます。

「"$LATEST" と "最後に発行されたバージョン"との間でコード差分がない」のに新バージョンを発行しようとしてエラーになる
「"$LATEST" と "最後に発行されたバージョン"との間でコード差分がある」のに既に発行済みのバージョンに紐づく識別子を指定してしまいエラーになる

先ほどの行を以下のように変更した場合について考えてみます。

fn.addVersion('1'); // <-- バージョン１を発行したい

これは、最初のデプロイでは問題なくバージョン1が発行されます。

この状態で、関数コードが変更されていないのに、バージョン識別子をうっかり更新してしまった場合、

fn.addVersion('2'); // <-- コードが変更されていないのにバージョン2にしてしまった

以下のようなエラーになります。

1/3 | 2:29:21 PM | CREATE_FAILED        | AWS::Lambda::Version  | CdkLambdaFunction/Version2 (CdkLambdaFunctionVersion3FF20C5FC) A version for this Lambda function exists ( 1 ). Modify the function to create a new version.
        new Version (/home/vsonline/workspace/o-aws-lambda-version-cdk/node_modules/@aws-cdk/aws-lambda/lib/lambda-version.ts:137:21)

また、関数コードが変更された場合に、過去のバージョンを指定してしまっても、同じようなエラーになります。

自分でバージョン識別子を個別に指定する場合は、このような「＄LATESTとの食い違い」に注意する必要がありそうです。

まとめ

Lambda functionとバージョン発行の挙動を検証し、AWS CDKにて構築する際にエラーとなる場合について解説しました。

関数コードの変更による、$LATESTと新バージョン発行の挙動について、正しく理解できていれば、CDKデプロイ時のエラーに悩むこともないはずです。

今回のCDKコードはサンプル的なものなので、バージョンの扱いにはより良い方法もあるかと思いますが、参考になれば幸いです。