API Gateway コンソールから REST API をデプロイする - Amazon API Gateway

API Gateway コンソールから REST API をデプロイする

REST API は、初めてデプロイする前に作成済みであることが必要です。詳細については、「Amazon API Gateway での REST API の作成」を参照してください。

REST API をステージにデプロイする

API Gateway コンソールでは、デプロイを作成して新規または既存のステージに関連付けることで API をデプロイできます。

注記

API Gateway のステージを異なるデプロイに関連付けるには、代わりに「ステージを別の REST API デプロイと関連付ける」を参照してください。

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

  2. [API] ナビゲーションペインで、デプロイする API を選択します。

  3. [リソース] ペインで、[API のデプロイ] を選択します。

  4. [ステージ] では、次の中から選択します。

    1. 新しいステージを作成するには、[新規ステージ] を選択し、[ステージ名] に名前を入力します。オプションで [デプロイの説明] にこのデプロイの説明を入力できます。

    2. 既存のステージを選択するには、ドロップダウンメニューからステージ名を選択します。[デプロイの説明] に新しいデプロイの説明を入力することもできます。

    3. ステージに関連付けられていないデプロイを作成するには、[ステージなし] を選択します。後で、このデプロイをステージに関連付けることができます。

  5. [デプロイ] を選択します。

REST API をステージに再デプロイする

API を再デプロイするには、「REST API をステージにデプロイする」と同じ手順を実行します。同じステージを必要に応じて何度でも再利用することができます。

REST API デプロイのステージ設定を更新する

API のデプロイ後に、ステージ設定を変更して API キャッシュ、ログ記録、またはリクエストのスロットリングを有効または無効にすることができます。また、バックエンドで API Gateway を検証するためのクライアント証明書を選択したり、ランタイム時に API 統合にデプロイコンテキストを渡すようにステージ変数を設定したりすることもできます。詳細については、「ステージ設定の更新」を参照してください。

重要

ステージ設定を変更したら、変更を有効にするために API を再デプロイする必要があります。

注記

ログ記録の有効化など、更新した設定が新しい IAM ロールを必要とする場合、API を再デプロイせずに必要な IAM ロールを追加できます。ただし新しい IAM ロールが有効になるまでには、数分かかる場合があります。有効になるまでは、ログ作成オプションを有効にしていたとしても、API 呼び出しのトレースは記録されません。

REST API デプロイのステージ変数を設定する

デプロイで、ランタイムに API 統合に対してデプロイ固有のデータを渡すようにステージ変数を設定または変更できます。この操作は、[ステージエディター] の [ステージ変数] タブで行うことができます。詳細については、「REST API デプロイのステージ変数のセットアップ」の手順を参照してください。

ステージを別の REST API デプロイと関連付ける

デプロイは API スナップショットを表し、ステージはスナップショットへのパスを定義するため、別のデプロイとステージの組み合わせを選択して、ユーザーが API の異なるバージョンを呼び出す方法を制御できます。これは、API のステージを前のデプロイにロールバックしたり、API の「プライベートブランチ」をパブリックブランチにマージしたりする場合に役立ちます。

次の手順では、この操作を API Gateway コンソールの [Stage Editor (ステージエディター)] を使用して行う方法について説明します。以下では、API を複数回デプロイした経験があることを前提としています。

  1. まだ [ステージ] ペインを開いていない場合は、メインナビゲーションペインで [ステージ] を選択します。

  2. 更新するステージを選択します。

  3. [デプロイ履歴] タブで、ステージに使用するデプロイを選択します。

  4. [アクティブなデプロイの変更] を選択します。

  5. アクティブなデプロイを変更することを確認し、[アクティブなデプロイを作成] ダイアログボックスの [アクティブなデプロイを変更] を選択します。