API Gateway API のカスタムドメイン名を定義する方法を教えてください。

最終更新日: 2020 年 5 月 22 日

デフォルトのベース URL を使用する代わりに、Amazon API Gateway API にカスタムドメイン名を使用したいと考えています。セットアップ方法を教えてください。

簡単な説明

API Gateway では、エッジ最適化カスタムドメイン名または リージョン別カスタムドメイン名のいずれかを作成できます。これらのタイプのカスタムドメイン名の間には、いくつかの重要な違いがあります。

カスタムドメイン名タイプ API タイプ ターゲットエンドポイント SSL/TLS 証明書 ドメイン名
エッジ最適化 エッジ最適化カスタムドメイン名を使用できるのは、REST API のみです。 examplek7xoo.cloudfront.net に類似した形式の Amazon CloudFront ディストリビューション 証明書は、米国東部 (バージニア北部) (us-east-1) の AWS リージョンにある必要があります。 ドメイン名は一意である必要があります。(これは CNAME として CloudFront ディストリビューションエンドポイントにアタッチされており、CNAME を複数の CloudFront ディストリビューションに関連付けることはできません)。
リージョン これらの API タイプはすべて、リージョン別カスタムドメイン名を使用できます。
REST API
WebSocket API
HTTP API
examplevpz7.execute-api.us-west-2.amazonaws.com に類似した形式のリージョン別 API エンドポイント 証明書は、API と同じリージョンに存在する必要があります。 ドメイン名は、異なるリージョンの他のリージョン別カスタムドメイン名と共有できます。

また、ドメイン名マッピングの主な違いは次のとおりです。

解決方法

SSL/TLS 証明書をリクエストまたはインポートする

API のカスタムドメイン名を作成する前に、AWS Certificate Manager (ACM) から SSL/TLS 証明書をリクエストするか、SSL/TLS 証明書を ACM にインポートする必要があります。詳細については、「AWS Certificate Manager で証明書を準備する」を参照してください。

証明書をリクエストまたはインポートするときは、以下の要件に注意してください。

  • ドメイン検証チェックに合格するには、代替ドメイン名としてカスタムドメイン名が証明書に含まれている必要があります。CloudFront ディストリビューション (エッジ最適化カスタムドメイン名用) での検証チェックの詳細については、「Amazon CloudFront でのドメインセキュリティを継続的に強化する」を参照してください。リージョン別カスタムドメイン名にも、同様の検証チェックがあります。
  • エッジ最適化されたカスタムドメイン名の場合、ACM 証明書は 米国東部 (バージニア北部) (us-east-1) リージョンにある必要があります。
  • リージョン別カスタムドメイン名の場合、ACM 証明書は API と同じリージョンに存在する必要があります。

カスタムドメイン名を作成する

API Gateway API タイプに応じて、カスタムドメイン名を作成する手順について次から選択します。

カスタムドメイン名をテストする

  1. カスタムドメイン名を作成したときに指定したベースパスマッピングを使用して、ドメイン名で curl コマンドを実行します。
    注: curl の詳細については、cURL プロジェクトのウェブサイトを参照してください。
  2. カスタムドメイン名に対するレスポンスが、API ステージ URL を呼び出すときに受け取るレスポンスと同じであることを確認します。

この記事はお役に立ちましたか?


請求に関するサポートまたは技術サポートが必要ですか?