aws/creating-api-gateway-stage

creating-api-gateway-stage は何をしますか？

AWS のベストプラクティスに従い、CloudWatch ログ記録、X-Ray トレーシング、スロットリング、WAF 統合、IAM ロールを備えた API Gateway ステージを作成します。開発、テスト、本番などの異なる環境に REST API をデプロイする際に使用します。

機能

• CloudWatch ログ記録: API の呼び出しログを有効にし、エラーやレイテンシを監視します。
• X-Ray トレーシング: リクエストのトレースを有効にし、パフォーマンスのボトルネックを特定します。
• スロットリング: レート制限とバースト制限を設定し、API を過負荷から保護します。
• WAF 統合: AWS WAF を関連付け、一般的な Web 攻撃から保護します。
• IAM ロール: 必要な権限を持つ IAM ロールを作成し、セキュリティを強化します。

前提条件

• AWS CLI がインストールされ、設定されていること。
• 適切な IAM 権限（apigateway:*、cloudwatch:*、xray:*、waf:*、iam:*）があること。
• 既存の REST API があること。

使用方法

1. API Gateway ステージの作成

   aws apigateway create-stage --rest-api-id <api-id> --stage-name <stage-name> --description "<description>"
   

2. CloudWatch ログの有効化

   aws apigateway update-stage --rest-api-id <api-id> --stage-name <stage-name> --patch-operations op=replace,path=/accessLogSettings/destinationArn,value=<log-group-arn>
   

3. X-Ray トレーシングの有効化

   aws apigateway update-stage --rest-api-id <api-id> --stage-name <stage-name> --patch-operations op=replace,path=/tracingEnabled,value=true
   

4. スロットリングの設定

   aws apigateway update-stage --rest-api-id <api-id> --stage-name <stage-name> --patch-operations op=replace,path=/methodSettings/*/*/throttlingRateLimit,value=<rate-limit> op=replace,path=/methodSettings/*/*/throttlingBurstLimit,value=<burst-limit>
   

5. WAF の関連付け

   aws waf associate-web-acl --web-acl-id <waf-id> --resource-arn <api-arn>
   

6. IAM ロールの作成

   aws iam create-role --role-name <role-name> --assume-role-policy-document file://trust-policy.json
   

注意点

• スロットリングの値は API の使用パターンに基づいて調整してください。
• WAF ACL は事前に作成しておく必要があります。
• CloudWatch ロググループの保持期間を設定してコストを管理してください。
• X-Ray トレーシングは追加料金が発生する場合があります。

例

# 開発環境のステージを作成
aws apigateway create-stage --rest-api-id abc123 --stage-name dev --description "開発環境"

# 本番環境のステージを作成
aws apigateway create-stage --rest-api-id abc123 --stage-name prod --description "本番環境"

トラブルシューティング

• エラー: AccessDeniedException - IAM 権限が不足しています。必要な権限が付与されているか確認してください。
• エラー: NotFoundException - API ID またはステージ名が間違っています。正しい値を指定してください。
• WAF の関連付けに失敗する - WAF ACL と API が同じリージョンにあることを確認してください。

参考リンク

• AWS API Gateway ドキュメント
• AWS X-Ray ドキュメント
• AWS WAF ドキュメント