API Gateway で REST API をデプロイします。 - Amazon API Gateway

API Gateway で REST API をデプロイします。

API Gateway では、REST API のデプロイは Deployment リソースにより表現されます。これは、RestApi リソースによって表される API の実行可能ファイルと似ています。

クライアントが API を呼び出すには、デプロイを作成してステージを関連付ける必要があります。ステージは、Stage リソースによって表されます。これは、メソッド、統合、モデル、マッピングテンプレート、Lambda オーソライザー (以前のカスタムオーソライザー) を含む API のスナップショットを表します。API を更新すると、新しいステージを既存のステージに関連付けることによって API を再デプロイできます。ステージの作成については、REST API のステージのセットアップ で説明されています。

AWS CLI を使用してデプロイを作成する

デプロイを作成するときは、Deployment リソースをインスタンス化します。API Gateway コンソール、AWS CLI、AWS SDK、または API Gateway REST API を使用して、デプロイを作成できます。

CLI を使用してデプロイを作成するには、create-deployment コマンドを使用します。

aws apigateway create-deployment --rest-api-id <rest-api-id> --region <region>

このデプロイをステージに関連付けるまで、API は呼び出し可能ではありません。既存のステージでは、ステージの deploymentId プロパティを新しく作成されたデプロイ ID (<deployment-id>) で更新することで実行できます。

aws apigateway update-stage --region <region> \ --rest-api-id <rest-api-id> \ --stage-name <stage-name> \ --patch-operations op='replace',path='/deploymentId',value='<deployment-id>'

初めて API をデプロイする場合は、ステージの作成とデプロイの作成を同時に行うことができます。

aws apigateway create-deployment --region <region> \ --rest-api-id <rest-api-id> \ --stage-name <stage-name>

これは、初めて API をデプロイするとき、または API を新しいステージに再デプロイするときに、API Gateway コンソールの背後で行われる処理です。