カスタムドメインを使って、API Gatewayに独自ドメインでアクセスする方法をまとめます。
本記事は「エッジ最適化編(API Gatewayのエンドポイントをエッジ最適化に設定)」で CloudFrontを利用するので、グローバルに展開するサービスに良いと思います。
また、API Gateway につながる実際の APIについては「API Gateway、Lambda(Node.js)、DynamoDB を使ったAPIの作り方」で作ったAPIを利用するので、こちらを先に見ておくと良いかと思います。
ちなみに、CloudFrontを利用しないリージョン編については、「API Gatewayに独自ドメインでアクセスする方法(リージョン編)」を参考にしてください。
前提
route53でドメインを取得していること。
本記事では取得済ドメインの サブドメイン を利用します。
ACMでSSL証明書を発行
ACM(Certificate Manager)を使って取得済ドメインのSSL証明書を発行します。
今回はエッジ最適化編なので、米国北部(バージニア北部)リージョンで証明書を発行する必要があります。
「バージニア北部」リージョンを選択してから、「証明書をリクエスト」をクリックします。
「パブリック証明書をリクエスト」が選択されているので、そのまま「次へ」をクリックします。
「完全修飾ドメイン名」入力欄に値を入力します。例えば取得済ドメインが「hoge.com」ならば、「*.hoge.com」と入力しましょう。
検証方法は推奨されている「DNS検証」のまま、「リクエスト」をクリックします。
すると以下のような画面になり、まだ保留中のままになっているので、「証明書ID」のリンクをクリックします。
すると以下のような画面になります。あとで route53で利用するので「CNAME名」と「CNAME値」を控えておきます。
route53 で CNAME を設定する
route53の画面を選択、既に作成済ドメインのホストゾーンを選択して、以下のように「レコードを作成」をクリックします。
レコードタイプに「CNAME」を選択し、前述の「CNAME名」と「CNAME値」を入力します。
その後、約20分ほどで SSL証明書が発行済となります。
以下ACMの画面からも、「発行済み」になっていることを確認できます。
API Gateway でカスタムドメインを作成
カスタムドメインを選択して「作成」をクリックします。
忘れがちですが、ここからはバージニア北部リージョンである必要はありません。東京リージョンに変更します。
カスタムドメイン名(例えば取得済ドメインがhogehoge.comならば、api.hogehoge.comとする)を入力します。
その後、エンドポイント設定を「エッジ最適化」にチェックすると、ACM証明書のところで、前述のバージニア北部で発行したSSL証明書が選べるので選択をします。
その後に「ドメイン名を作成」をクリックします。
すると、以下のようにカスタムドメインが出来ます。
ここで注目すべきポイントは、「API Gatewayドメイン名」に cloudfront.net が作成されているところです。これは後ほど route53の設定で利用するので覚えておきましょう。
続いて「APIマッピング」タブを選択して、「APIマッピングを設定」をクリックします。
APIの欄に API GatewayのAPI(ここでは「API Gateway、Lambda(Node.js)、DynamoDB を使ったAPIの作り方」を利用)、ステージには同じくAPI Gatewayのステージを選択します。
パスは任意で設定します。ここではAPIをバージョン管理できるように「v1」とつけておきます。これにより、URLが https://api.hogehoge.com/v1/ などになります。
全て設定できたら、「保存」をクリックします。
再び route53でサブドメインを設定
API Gatewayのカスタムドメインが設定できたら、route53でそのカスタムドメイン(サブドメイン)を設定します。
以下のよう該当のホストゾーンから「レコードを作成」をクリックします。
レコード名には、カスタムドメインと同じく「api」を設定して、レコードタイプは「Aレコードとします」
トラフィックのルーティングは以下のようになりますが、ここで注目すべきは、前述で出てきた cloudfront.net が選べるようになっていることです。cloudfront.net を選んで「レコードを作成」をクリックしましょう。
以上で独自ドメイン(カスタムドメイン)でAPI Gateway が利用できるようになりました。
ためしに postman でアクセスしてみましょう。
前述したように、API GatewayのAPIには(API Gateway、Lambda(Node.js)、DynamoDB を使ったAPIの作り方)で作成したAPIがつながっているので、リクエストJsonを以下のようにします。
{
"action": "overview",
"eid": "00001"
}
postmanでは以下のように正常にレスポンスが返ってきたことが分かります。
以上です。