API GatewayのゲートウェイレスポンスをCloudFormationで設定する方法

2025年7月9日

当ページのリンクには広告が含まれています。

この記事で解決できる悩み

ゲートウェイレスポンスをCloudFormationで設定する方法は？
ゲートウェイレスポンスのレスポンスタイプは？

いずみ

こんな悩みを解決できる記事を書きました！

僕は現役フリーランスエンジニア（歴10年）で、資格は13個保有しています。

結論、API GatewayのゲートウェイレスポンスをCloudFormationで設定するのは非常に簡単です。

具体的なソースコードを載せているので安心してくださいね。

本記事を読めば、API GatewayのゲートウェイレスポンスをCloudFormationで設定する方法が理解できるので早速見ていきましょう。

いずみ

すぐ読み終わるので、ぜひ最後まで読んでくださいね♪

執筆者／監修者

フリーランスエンジニア（保有資格13個）
ブログ・アフィリエイト歴7年（2018年〜）
ブランドせどりで月利50万円⇨脱サラ
投資（仮想通貨・FX）歴7年（2018年〜）
X（旧Twitter）フォロワー約1,900人
運営者情報はこちら

いずみです

ゲートウェイレスポンスをCloudFormationで設定する方法

早速ですが、ゲートウェイレスポンスをCloudFormationで設定する方法を解説します。

STEP

yamlファイルを準備

AWSTemplateFormatVersion: 2010-09-09
Resources:
  RestApi:
    Type: AWS::ApiGateway::RestApi
    Properties:
      Name: hello-world
  GatewayResponse:
    Type: AWS::ApiGateway::GatewayResponse
    Properties:
      ResponseParameters:
        gatewayresponse.header.Access-Control-Allow-Origin: "'*'"
      ResponseType: EXPIRED_TOKEN
      RestApiId: !Ref RestApi
      StatusCode: '403'

yamlファイルを用意します。

いずみ

今回は、hello-worldというAPI Gatewayにゲートウェイレスポンスの設定を追加します。

EXPIRED_TOKEN（期限切れのトークン）のレスポンスヘッダに「Access-Control-Allow-Origin」を設定します。

STEP

スタックの作成

CloudFormationを開き、スタックの作成をクリックします。

STEP

スタックの作成

先ほど作成したyamlファイルをアップロードし、次へをクリックします。

STEP

スタックの詳細を指定

スタックの名前を入力し、次へをクリックします。

STEP

詳細オプション

デフォルトのまま、次へをクリックします。

STEP

詳細オプション

デフォルトのまま、送信をクリックします。

STEP

スタックのステータスを確認

スタックのステータスが「CREATE_COMPLETE」になればOKです。

STEP

API Gatewayの確認

API Gatewayのゲートウェイレスポンスにレスポンスヘッダが設定されていれば完了です。

いずみ

簡単でしたね。

ゲートウェイレスポンスのレスポンスタイプ

ゲートウェイレスポンスのレスポンスタイプ（responseType）は以下になります。

DEFAULT_4XX
DEFAULT_5XX
RESOURCE_NOT_FOUND
UNAUTHORIZED
INVALID_API_KEY
ACCESS_DENIED
AUTHORIZER_FAILURE
AUTHORIZER_CONFIGURATION_ERROR
INVALID_SIGNATURE
EXPIRED_TOKEN
MISSING_AUTHENTICATION_TOKEN
INTEGRATION_FAILURE
INTEGRATION_TIMEOUT
API_CONFIGURATION_ERROR
UNSUPPORTED_MEDIA_TYPE
BAD_REQUEST_PARAMETERS
BAD_REQUEST_BODY
REQUEST_TOO_LARGE
THROTTLED
QUOTA_EXCEEDED

よくある質問

GatewayResponseの公式ドキュメントはありますか？

下記になります。

公式

GatewayResponse – Amazon API Gateway A gateway response of a given response type and status code, with optional response parameters and mapping templates.

公式

AWS::ApiGateway::GatewayResponse – AWS CloudFormation Use the AWS CloudFormation AWS::ApiGateway::GatewayResponse resource for ApiGateway.