[小ネタ] API Gateway のプライベート API とプライベート統合の違い

アノテーション・テクニカルサポートチームの hato です。

Amazon API Gateway と VPC を繋ぐ仕組みには「プライベート API」と「プライベート統合」がありますが、IN/OUTどっちがどっち？とわからない時があるため、簡単な図でまとめてみました。

プライベート API

VPC から API Gateway へのアクセスの話となります。

EC2 等の VPC 内部のリソースから、インターフェイス VPC エンドポイントを介して、API Gateway（プライベート API）にアクセスします。
API Gateway にアクセスする際の選択肢です。2024年8月時点では REST API で選択可能です。

関連する AWS 公式ドキュメントは次が該当します。

• API Gateway のプライベート REST API - Amazon API Gateway
• チュートリアル: プライベート REST API を作成する - Amazon API Gateway

プライベート統合

API Gateway から VPC 内にアクセスする際の話となります。

API Gateway から、VPC 内の NLB 等を経由して EC2 といった VPC 内部のリソースにアクセスします。
API Gateway からバックエンドにアクセスする際の選択肢です。

関連する AWS 公式ドキュメントは次が該当します。

• API Gateway での REST API のプライベート統合 - Amazon API Gateway
• HTTP API のプライベート統合を作成する - Amazon API Gateway
• API Gateway で WebSocket API 統合リクエストを設定する - Amazon API Gateway

最後に

テクニカルサポート業務に使えるシンプルな図が欲しくて作成しました。この記事が誰かのお役にたてば幸いです。
なお、詳しい仕組みは次の AWS ブログで紹介されています。

Understanding VPC links in Amazon API Gateway private integrations | AWS Compute Blog

参考資料

• Amazon API Gateway の概念 - Amazon API Gateway

プライベート API エンドポイント
インターフェイス VPC エンドポイントを介して公開された API エンドポイント。これにより、クライアントは VPC 内部で安全にプライベート API リソースにアクセスすることができます。プライベート API はパブリックインターネットからは分離されており、アクセス権限を付与されている API Gateway の VPC エンドポイントを使用してのみアクセスできます。

…（中略）…

プライベート統合
クライアントが、リソースをパブリックインターネットに公開することなく、プライベート REST API エンドポイントを介してお客様の VPC 内のリソースにアクセスする、API Gateway の統合タイプです。

• API Gateway をオンプレミスネットワークに接続する | AWS re:Post

アノテーション株式会社について

アノテーション株式会社はクラスメソッドグループのオペレーション専門特化企業です。サポート・運用・開発保守・情シス・バックオフィスの専門チームが、最新 IT テクノロジー、高い技術力、蓄積されたノウハウをフル活用し、お客様の課題解決を行っています。当社は様々な職種でメンバーを募集しています。「オペレーション・エクセレンス」と「らしく働く、らしく生きる」を共に実現するカルチャー・しくみ・働き方にご興味がある方は、アノテーション株式会社 採用サイト をぜひご覧ください。