HTTP API のデフォルトのエンドポイントを無効にする - Amazon API Gateway

HTTP API のデフォルトのエンドポイントを無効にする

デフォルトでは、クライアントは、API Gateway が API 用に生成する execute-api エンドポイントを使用して API を呼び出すことができます。クライアントがカスタムドメイン名を使用した場合のみ API にアクセスできるようにするには、デフォルトの execute-api エンドポイントを無効にします。デフォルトのエンドポイントを無効にすると、API のすべてのステージに影響します。

次の手順では、HTTP API のデフォルトのエンドポイントを無効にする方法を示します。

AWS Management Console

  1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

  2. HTTP API を選択します。

  3. API の ID を選択して、[API の詳細] ページを開きます。

  4. [API の詳細] で、[編集] を選択します。

  5. [デフォルトのエンドポイント] で、[無効化] を選択します。

  6. [Save] を選択します。

    ステージの自動デプロイを有効にすると、変更を有効にするために API を再デプロイする必要はありません。それ以外の場合は、API を再デプロイする必要があります。

  7. (オプション) [デプロイ] を選択して API を再デプロイするか、新しいステージを作成して変更を有効にします。

AWS CLI

次の update-domain-name コマンドでは、HTTP API のデフォルトのエンドポイントを無効にします。

aws apigatewayv2 update-api \
    --api-id abcdef123 \
    --disable-execute-api-endpoint

デフォルトエンドポイントを無効にした後は、自動デプロイが有効になっている場合を除き、その変更を有効にするために API をデプロイする必要があります。

次の create-deployment コマンドでは、デプロイを作成します。

aws apigatewayv2 create-deployment \
    --api-id abcdef123 \
    --stage-name dev