Amazon API Gateway REST API を Amazon SQS と統合して、Lambda 関数を非同期に呼び出す構成を AWS CDK で構築する

[クライアント] --> [REST API] --> [SQS キュー] <-- 消費 -- [Lambda 関数]

import * as cdk from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import * as iam from "aws-cdk-lib/aws-iam";
import * as lambda from "aws-cdk-lib/aws-lambda";
import { SqsEventSource } from "aws-cdk-lib/aws-lambda-event-sources";
import * as lambda_nodejs from "aws-cdk-lib/aws-lambda-nodejs";
import * as log from "aws-cdk-lib/aws-logs";
import * as sqs from "aws-cdk-lib/aws-sqs";
import { Construct } from "constructs";

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

    /**
     * Lambda 関数作成
     */
    const lambdaFunction = new lambda_nodejs.NodejsFunction(
      this,
      "LambdaFunction",
      {
        entry: "src/handler.ts",
        tracing: lambda.Tracing.ACTIVE, // AWS X-Ray によるトレースを有効化
      },
    );

    /**
     * SQS キュー作成
     */
    const queue = new sqs.Queue(this, "Queue");

    /**
     * Lambda 関数に SQS キューのメッセージ受信権限を付与し、イベントソースとして設定
     */
    queue.grantConsumeMessages(lambdaFunction);
    lambdaFunction.addEventSource(new SqsEventSource(queue));

    /**
     * API Gateway REST API 作成
     */
    const restApi = new apigateway.RestApi(this, "RestApi", {
      deployOptions: {
        /**
         * AWS X-Ray によるトレースを有効化
         */
        tracingEnabled: true,

        /**
         * アクセスログの有効化
         */
        accessLogDestination: new apigateway.LogGroupLogDestination(
          new log.LogGroup(this, "ApiGatewayAccessLogGroup"),
        ),
        accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields(),

        /**
         * 実行ログの有効化
         */
        loggingLevel: apigateway.MethodLoggingLevel.INFO,
        dataTraceEnabled: true,
      },
    });

    /**
     * SQS キューへメッセージを送信するための AWS 統合を作成
     * @see https://docs.aws.amazon.com/ja_jp/apigateway/latest/developerguide/api-gateway-api-integration-types.html
     */
    const sendMessageIntegration = new apigateway.AwsIntegration({
      service: "sqs",
      path: `${cdk.Aws.ACCOUNT_ID}/${queue.queueName}`, // アカウントID/キュー名のパスを指定
      integrationHttpMethod: "POST",
      options: {
        /**
         * コンテントタイプを Amazon SQS の POST リクエストがサポートする形式に設定
         *
         * MEMO: 設定しない場合は SendMessage API 呼び出しで 404 エラーとなる
         * @see https://docs.aws.amazon.com/ja_jp/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests-xml.html#structure-post-request
         */
        requestParameters: {
          "integration.request.header.Content-Type":
            "'application/x-www-form-urlencoded'",
        },

        /**
         * リクエストテンプレートを設定
         *
         * MEMO: 入力変数 `$input.body` を使用して、REST API のリクエストボディを SQS の SendMessage アクションのパラメータ形式に変換するテンプレートを指定
         * @see https://docs.aws.amazon.com/ja_jp/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
         */
        requestTemplates: {
          "application/json":
            "Action=SendMessage&MessageBody=$util.urlEncode($input.body)",
        },

        /**
         * 統合レスポンスを設定
         *
         * MEMO: REST API からクライアントへ固定のレスポンスを返すように設定
         */
        integrationResponses: [
          {
            statusCode: "200",
            responseTemplates: {
              "application/json": '{"status": "message sent"}',
            },
          },
        ],

        /**
         * REST API から SQS キューへのアクセス権限を付与する IAM ロールを指定
         */
        credentialsRole: new iam.Role(this, "ApiGatewaySqsRole", {
          assumedBy: new iam.ServicePrincipal("apigateway.amazonaws.com"),
          inlinePolicies: {
            AllowSqsSendMessage: new iam.PolicyDocument({
              statements: [
                new iam.PolicyStatement({
                  actions: ["sqs:SendMessage"],
                  resources: [queue.queueArn],
                }),
              ],
            }),
          },
        }),
      },
    });

    /**
     * API Gateway のリソースとメソッドを作成し、SQS キューへメッセージを送信する統合を設定
     */
    const queueResource = restApi.root.addResource("items");
    queueResource.addMethod("POST", sendMessageIntegration, {
      methodResponses: [
        {
          statusCode: "200",
        },
      ],
    });

    /**
     * API Gateway の ANY メソッドとプロキシリソースの設定例
     *
     * MEMO: このように任意のパスと HTTP メソッドで SQS キューにメッセージを送信する設定も可能。
     *       ただし、ダウンストリーム処理がパスおよびメソッドを識別可能とするためにはマッピングテンプレートの修正が必要となる。
     */
    // restApi.root.addMethod("ANY", sendMessageIntegration, {
    //   methodResponses: [{ statusCode: "200" }],
    // });
    // const proxyResource = restApi.root.addResource("{proxy+}");
    // proxyResource.addMethod("ANY", sendMessageIntegration, {
    //   methodResponses: [{ statusCode: "200" }],
    // });
  }
}

curl -X POST https://${API_ID}.execute-api.ap-northeast-1.amazonaws.com/prod/items \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello from API Gateway to SQS"}'

{
  "Records": [
    {
      "messageId": "a30ee7be-a622-453c-9563-ea145a05ff02",
      "receiptHandle": "AQEB598tg7avOpwo6n6v6k3+...<省略>...==",
      "body": "{\"message\": \"Hello from API Gateway to SQS\"}",
      "attributes": {
        "ApproximateReceiveCount": "1",
        "AWSTraceHeader": "Root=1-695674c9-59b472dd3a45eaca3912b9c1;Parent=77cf9d03313aaecd;Sampled=1",
        "SentTimestamp": "1767273673833",
        "SenderId": "AROAUL6WVPY2M6PC7BBKJ:BackplaneAssumeRoleSession",
        "ApproximateFirstReceiveTimestamp": "1767273673844"
      },
      "messageAttributes": {},
      "md5OfBody": "60945dbf651c26b11be8821471a2c923",
      "eventSource": "aws:sqs",
      "eventSourceARN": "arn:aws:sqs:ap-northeast-1:XXXXXXXXXXXX:Sample-Queue4A7E3555-5aSwyKDoa011",
      "awsRegion": "ap-northeast-1"
    }
  ]
}

restApi.root.addMethod("ANY", sendMessageIntegration, {
  methodResponses: [{ statusCode: "200" }],
});
const proxyResource = restApi.root.addResource("{proxy+}");
proxyResource.addMethod("ANY", sendMessageIntegration, {
  methodResponses: [{ statusCode: "200" }],
});

curl -X POST https://${API_}.execute-api.ap-northeast-1.amazonaws.com/prod/hello \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello from API Gateway to SQS"}'
{"status": "message sent"}

requestParameters: {
  "integration.request.header.Content-Type":
    "'application/x-www-form-urlencoded'",
},