API Gateway で REST API のステージをセットアップする

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

REST API を選択します。

メインナビゲーションペインで、API の下にある [ステージ] を選択します。

[ステージ] ナビゲーションペインから、[ステージの作成] を選択します。

[ステージ名] に、名前を入力します（例: prod）。

(オプション)。[説明] に、ステージの説明を入力します。

[デプロイメント] には、このステージに関連付ける既存の API デプロイの日付と時刻を選択します。

[追加設定] では、ステージの追加設定を指定できます。

[テーブルの作成] を選択します。

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

REST API を選択します。

メインナビゲーションペインで、API の下にある [ステージ] を選択します。

[Stages] (ステージ) ペインで、ステージの名前を選択します。

[ステージの詳細] セクションで、[編集] を選択します。

(オプション) [ステージの説明] で、説明を編集します。

[その他の設定] で、以下の設定を変更します。

[Continue] (続行) をクリックします。

変更内容を確認してから、[変更を保存] を選択します。

この API Gateway API のこのステージに関連付けられているすべてのメソッドで Amazon CloudWatch Logs を有効にするには、[ログとトレース] セクションで [編集] を選択します。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:DescribeLogGroups",
                "logs:DescribeLogStreams",
                "logs:PutLogEvents",
                "logs:GetLogEvents",
                "logs:FilterLogEvents"
            ],
            "Resource": "*"
        }
    ]
}

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "",
      "Effect": "Allow",
      "Principal": {
        "Service": "apigateway.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

[CloudWatch Logs] ドロップダウンメニューからログ記録レベルを選択します。ログ記録レベルは、以下のとおりです。

[データトレース] を選択すると、API Gateway がステージのデータトレースログを CloudWatch に報告します。このログは API のトラブルシューティングに役立ちますが、機密データが記録される可能性があります。

API Gateway から CloudWatch に API calls、Latency、Integration latency、400 errors、500 errors の API メトリクスをレポートするには、[詳細なメトリクス] を選択します。CloudWatch の詳細については、「Amazon CloudWatch ユーザーガイド」の「基本モニタリングと詳細モニタリング」を参照してください。

送信先へのアクセスログを有効にするには、[カスタムのアクセスログ] をオンにします。

[アクセスログの送信先 ARN] に、ロググループまたは Firehose ストリームの ARN を入力します。

Firehose の ARN 形式は arn:aws:firehose:{region}:{account-id}:deliverystream/amazon-apigateway-{your-stream-name} です。Firehose ストリームの名前は amazon-apigateway-{your-stream-name} にする必要があります。

[ログの形式] にログの形式を入力します。ログ形式の例について詳しくは、「API Gateway での CloudWatch によるログの形式」を参照してください。

API ステージで AWS X-Ray トレースを有効にするには、[X-Ray トレース] を選択します。詳細については、「API Gateway で X-Ray を使用して REST API へのユーザーリクエストをトレースする」を参照してください。

[Save changes] (変更の保存) をクリックします。API を再デプロイして新しい設定を有効にします。

メソッドのオーバーライドを設定するには、セカンダリナビゲーションペインでステージを展開し、メソッドを選択します。

次に、[メソッドオーバーライド] で [編集] を選択します。

メソッドレベルの CloudWatch 設定を有効にするには、CloudWatch Logs でログ記録レベルを選択します。

メソッドのデータトレースログ記録を有効にするには、[データトレース] を選択します。

メソッドレベルの詳細メトリクスを有効にするには、[詳細なメトリクス] を選択します。アカウントではメソッドレベルの CloudWatch メトリクスへのアクセスに対して課金されますが、API レベルまたはステージレベルのメトリクスでは課金されません。

メソッドレベルのスロットリングを有効にするには、[スロットリング] を選択します。適切なメソッドレベルのオプションを入力します。スロットリングの詳細については、「API Gateway のスループットを向上させるために REST API へのリクエストをスロットリングする」を参照してください。

メソッドレベルのキャッシュを設定するには、[メソッドキャッシュを有効にする] を選択します。[ステージの詳細] でデフォルトのメソッドレベルのキャッシュ設定を変更しても、この設定には影響しません。

[Save] を選択します。