AWS Lambdaにおけるサーバレスエラーハンドリング(3)

今回はAPI GatewayとLambda実行環境をCloudFormationを使って構築し、同期的にLambdaを呼び出してみます。

なお、API Gatewayおよび、Lambdaをマネジメントコンソール上から手動で構築する場合は、連載「AWSで作るクラウドネイティブアプリケーションの基本」の第21回以降で解説しているので、適宜参照してください。

LambdaファンクションのCloudFormationテンプレート

AWS LambdaをCloudFormationで構築するときのテンプレートの記述要領については、連載「AWSで実践! 基盤構築・デプロイ自動化」の第42回を参照してください。事前にLambdaをデプロイするためにビルドされたアプリケーションパッケージを配置するS3バケットを作成しておきます。また、Lambdaのテンプレートから参照するので、バケット名やARNをエクスポートします。

AWSTemplateFormatVersion: '2010-09-09'

Description: S3 Bucket for Lambda function template with YAML - S3 Bucket Definition

Resources:
  S3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: debugroom-mynavi-sample-lambda-errorhandling-for-deploy
      AccessControl: Private
      PublicAccessBlockConfiguration:
        BlockPublicAcls: True
        BlockPublicPolicy: True
        IgnorePublicAcls: True
        RestrictPublicBuckets: True

Outputs:
  S3Bucket:
    Description: Lambda deploy S3 bucket name
    Value: !Ref S3Bucket
    Export:
      Name: debugroom-mynavi-sample-lambda-errorhandling-deploy-s3-bucket

  S3BucketArn:
    Description: Deploy S3 for Lambda bucket arn
    Value: !GetAtt S3Bucket.Arn
    Export:
      Name: debugroom-mynavi-sample-lambda-errorhandling-deploy-s3-bucket-arn

続いて、前回実装したLambdaファンクションをビルドして、このバケットにアップロードしますが、以下のようなスクリプトを実行すると簡易です。Java仮想マシンのルートディレクトリとなるJAVA_HOME環境変数やMavenのビルドコマンドのパスなどは、適宜自分の環境に合わせて書き換えてください。なお、コマンドを実行するためのAWS CLIのインストールや開発端末の認証情報の設定は、連載「AWSで実践! 基盤構築・デプロイ自動化」の第22回で解説した手順に沿って行っておくとよいでしょう。

#!/usr/bin/env bash

export JAVA_HOME=/usr/lib/jvm/java-11-amazon-corretto.x86_64
bucket_name="debugroom-mynavi-sample-lambda-errorhandling-for-deploy"
stack_name="mynavi-sample-deploy-s3-for-lambda-errorhandling"
template_path="cloudformation/1-s3-for-lambda-deploy-cfn.yml"
s3_objectkey="spring-cloud-3-1-lambda-function-0.0.1-SNAPSHOT-aws.jar"

if [ "" == "`aws s3 ls | grep $bucket_name`" ]; then
    aws cloudformation deploy --stack-name ${stack_name} --template-file ${template_path} --capabilities CAPABILITY_IAM
fi

cd spring-cloud-3-1-lambda-function
./mvnw clean package
aws s3 cp target/${s3_objectkey} s3://${bucket_name}/

続いて、Lambda実行環境のCloudFormationテンプレートを実装します。

AWSTemplateFormatVersion: '2010-09-09'

#omit

Resources:
  LambdaForSyncExecuteBusinessErrorFuntion:
    Type: AWS::Lambda::Function
    Properties:
      Code:
        S3Bucket:
          Fn::ImportValue: debugroom-mynavi-sample-lambda-errorhandling-deploy-s3-bucket  #(1)
        S3Key: spring-cloud-3-1-lambda-function-0.0.1-SNAPSHOT-aws.jar
      Handler: org.springframework.cloud.function.adapter.aws.FunctionInvoker::handleRequest #(2)
      FunctionName: mynavi-sample-aws-lambda-errorhandling-sync-business-error
      Environment:
        Variables:
          SPRING_CLOUD_FUNCTION_DEFINITION: syncExecuteBusinessErrorFunction #(3)
      MemorySize: 1024
      Runtime: java11
      Timeout: 120
      Role: !GetAtt LambdaRole.Arn #(4)

  #omit

  LambdaRole:
    Type: AWS::IAM::Role
    Properties:
      Path: /
      AssumeRolePolicyDocument:
        Statement:
          - Action: sts:AssumeRole
            Effect: Allow
            Principal:
              Service: lambda.amazonaws.com
            ManagedPolicyArns:
              - arn:aws:iam::aws:policy/service-role/AWSLambdaVPCAccessExecutionRole

  #omit

Outputs:
  #omit

  LambdaForSyncExecuteBusinessErrorFuntion: #(5)
    Description: Sync execute Lambda function for occuring business error function.
    Value: !Ref LambdaForSyncExecuteBusinessErrorFuntion
    Export:
      Name: mynavi-sample-lambda-errorhandling-sync-execute-business-error-function-name

  LambdaForSyncExecuteBusinessErrorFuntionArn: #(6)
    Description: Sync execute Lambda function for occuring business error function.
    Value: !GetAtt LambdaForSyncExecuteBusinessErrorFuntion.Arn
    Export:
      Name: mynavi-sample-lambda-errorhandling-sync-execute-business-error-function-arn

  #omit

Lambdaテンプレートのポイントの詳細は以下の通りです。

API GatewayのCloudFormationテンプレート

続いて、Lambdaファンクションを呼び出すAPI GatewayのCloudformationテンプレートを実装します。

AWSTemplateFormatVersion: '2010-09-09'

#omit

Resources:
  ApiGatewayRestApi: #(1)
    Type: "AWS::ApiGateway::RestApi"
    Properties:
      Name: "mynavi-sample-lambda-errorhandling-rest-api"
      Description: "Mynavi sample sync execute function API"

  ApiGatewayDeployment: #(2)
    Type: "AWS::ApiGateway::Deployment"
    DependsOn:
      - ApiGatewayBusinessExceptionMethod
    Properties:
      RestApiId:
        Ref: ApiGatewayRestApi

  ApiGatewayStage: #(3)
    Type: "AWS::ApiGateway::Stage"
    Properties:
      StageName: "dev"
      Description: "dev stage"
      RestApiId:
        Ref: ApiGatewayRestApi
      DeploymentId:
        Ref: ApiGatewayDeployment

  ApiGatewayModel: #(4)
    Type: "AWS::ApiGateway::Model"
    Properties:
      RestApiId:
        Ref: ApiGatewayRestApi
      ContentType: "application/json"
      Name: SampleSchema
      Schema:
        "$schema": "http://json-schema.org/draft-04/schema#"
        title: SampleResource  #(5)
        type: object
        properties:
          message:
            type: string

  ApiGatewayBusinessExceptionResource:  #(6)
    Type: "AWS::ApiGateway::Resource"
    Properties:
      RestApiId:
        Ref: ApiGatewayRestApi
      ParentId:
        Fn::GetAtt:
          - ApiGatewayRestApi
          - RootResourceId
      PathPart: "business-exception-sample-resource"

   #omit

  ApiGatewayBusinessExceptionMethod: #(7)
    Type: "AWS::ApiGateway::Method"
    DependsOn: ApiGatewayModel
    Properties:
      RestApiId:
        Ref: ApiGatewayRestApi
      ResourceId:
        Ref: ApiGatewayBusinessExceptionResource
      HttpMethod: "GET"
      AuthorizationType: "NONE"
      Integration:
        Type: "AWS_PROXY"  #(8)
        Uri:  #(9)
          Fn::Join:
            - ""
            - - "arn:aws:apigateway"
              - ":"
              - Ref: AWS::Region
              - ":"
              - "lambda:path/2015-03-31/functions/"
              - Fn::ImportValue: mynavi-sample-lambda-errorhandling-sync-execute-business-error-function-arn
              - "/invocations"
        IntegrationHttpMethod: "POST"
        IntegrationResponses:
          - StatusCode: 400
            SelectionPattern: 400
          - StatusCode: 200
        PassthroughBehavior: WHEN_NO_MATCH
      MethodResponses:  #(10)
        - StatusCode: 200
          ResponseModels:
            application/json: SampleSchema
        - StatusCode: 400
          ResponseModels:
            application/json: Error

  #omit

  ApiGatewayUsagePlan: #(11)
    Type: AWS::ApiGateway::UsagePlan
    Properties:
      ApiStages:
        - ApiId:
            Ref: ApiGatewayRestApi
          Stage:
            Ref: ApiGatewayStage
      Quota:
        Limit: 100
        Period: DAY
      Throttle:
        BurstLimit: 10
        RateLimit: 2
      UsagePlanName: "SampleUsagePlan"

  BusinessErrorLambdaPermission: #(12)
    Type: "AWS::Lambda::Permission"
    Properties:
      FunctionName:
        Fn::ImportValue: mynavi-sample-lambda-errorhandling-sync-execute-business-error-function-name
      Action: "lambda:InvokeFunction"
      Principal: "apigateway.amazonaws.com"

API Gatewayテンプレートのポイントの詳細は以下の通りです。

作成したテンプレートをCLIから実行すると、環境が構築されます。マネジメントコンソール上で、以下のように作成したリソースのメソッドを選択し、赤枠で囲まれたテストを選択してください。

クエリ文字列を指定しない状態で「テスト」ボタンを押下すると、ステータスコード400で返却されます。何かしらの文字列を指定すると、ステータスコード200で正常応答します（なお、初回の実行はLambdaの起動でタイムアウトになるケースもあります）。

*　*　*

今回は、CloudFormationを使ってAPI GatewayとLambdaを構築し、Lambdaを同期的に呼び出してビジネスエラーを発生させ、エラーに応じてステータスコードが適切にマッピングするように設定する例を解説しました。次回以降は、同じくAPI GatewayとLambdaを使用した同期呼び出しで、システムエラーが発生した際に、CloudWatchに出力されたエラーログを契機として、システム管理者へ通知を行う実装を含めて解説していきます。