オンプレミスネットワークから API Gateway に接続するにはどうすればよいですか?

簡単な説明

API Gateway API タイプには、REST API (エッジ最適化およびリージョンレベルの API エンドポイント)、HTTP API、WebSocket API、およびプライベート REST API が含まれます。REST API、HTTP API、および WebSocket API は、オンプレミスネットワークから直接接続できます。プライベート REST API には、インターフェイス VPC エンドポイントを使用して Amazon Virtual Private Cloud (Amazon VPC) 内からのみアクセスできます。

解決方法

開始する前に、オンプレミスネットワークが次のとおりであることを確認します。

• インターネットに接続できる。
• ファイアウォールが API Gateway エンドポイントとの双方向トラフィックを許可している。

オンプレミスネットワークを REST API、HTTP API、または WebSocket API に接続する

API のタイプに応じて、invoke を使用してオンプレミスネットワークを API Gateway に接続します。

REST API については、「Amazon API Gateway での REST API の呼び出し」を参照してください。

HTTP API については、「顧客が呼び出すための HTTP API の公開」を参照してください。

WebSocket API については、「wscat を使用した WebSocket API への接続とメッセージの送信」を参照してください。

オンプレミスネットワークをプライベート REST API に接続する

プライベート REST API には、インターフェイス VPC エンドポイントを使用して Amazon VPC 内からアクセスできます。設定に応じて、次のアクセス方法を使用します。

注:

• インターフェイスエンドポイントのセキュリティグループは、TCP ポート 443 でオンプレミスのソース CIDR 範囲からのインバウンドトラフィックを許可する必要があります。
• プライベート API リソースポリシーを更新して、ソース VPC または VPC エンドポイントからのプライベート API トラフィックを許可する必要があります。

AWS Direct Connect

Direct Connect を使用して、オンプレミスネットワークを Amazon VPC に接続し、パブリック DNS 名を使用してプライベート API にアクセスできます。詳細については、「Direct Connect を使用したプライベート API へのアクセス」を参照してください。

Amazon Route 53 エイリアス

Amazon VPC エンドポイントをプライベート REST API に関連付けるステップに従います。

その後、API Gateway は、新しい Route 53 ALIAS DNS レコードを生成します。このレコードを使用して、次の URL 形式でプライベート API を呼び出すことができます。

https://{rest-api-id}-{vpce-id}.execute-api.{region}.amazonaws.com/{stage}

詳細については、「Route 53 エイリアスを使用したプライベート API へのアクセス」を参照してください。

プライベート DNS 名

プライベート DNS を使用している場合は、プライベート DNS 名を使用してオンプレミスネットワークからプライベート API にアクセスできます。Route 53 Resolver のインバウンドエンドポイントを設定し、オンプレミスネットワークからプライベート DNS のすべての DNS クエリをそのエンドポイントに転送する必要があります。詳細については、「プライベート DNS 名を使用してプライベート API を呼び出す」を参照してください。

パブリック DNS 名

エンドポイント固有の DNS ホスト名を使用して、オンプレミスネットワークからプライベート API にアクセスできます。パブリック DNS ホスト名には、次の URL 形式でプライベート API の VPC エンドポイント ID または API ID が含まれます。

https://{public-dns-hostname}.execute-api.{region}.vpce.amazonaws.com/{stage}

詳細については、「エンドポイント固有のパブリック DNS ホスト名を使用したプライベート API の呼び出し」を参照してください。

---

関連情報

VPC エンドポイントがオンプレミス DNS を使用する場合、プライベート API Gateway API にアクセスするにはどうすればよいですか?