API Gateway で HTTP API の VPC リンクを設定する
VPC リンクを使用すると、Application Load Balancer または Amazon ECS コンテナベースのアプリケーションなどの、HTTP API ルートを VPC 内のプライベートリソースに接続するプライベート統合を作成できます。プライベート統合の作成の詳細については、「API Gateway で HTTP API のプライベート統合を作成する」を参照してください。
プライベート統合は、VPC リンクを使用して、API Gateway と、対象となる VPC リソース間の接続をカプセル化します。異なるルートと API 間で VPC リンクを再利用できます。
VPC リンクを作成すると、API Gateway はアカウントの VPC リンク用の Elastic Network Interface を作成および管理します。このプロセスには数分かかることがあります。VPC リンクを使用する準備ができたら、状態は PENDING
から AVAILABLE
に移行します。
注記
VPC リンク経由で 60 日間トラフィックが送信されない場合は、INACTIVE
になります。VPC リンクが INACTIVE
状態の場合、API Gateway は VPC リンクのネットワークインターフェイスをすべて削除します。これにより、VPC リンクに依存する API リクエストが失敗します。API リクエストが再開すると、API Gateway はネットワークインターフェイスを再プロビジョニングします。ネットワークインターフェイスを作成し、VPC リンクを再度アクティブ化するには、数分かかることがあります。VPC リンクステータスを使用して、VPC リンクの状態を監視できます。
AWS CLI を使用して VPC リンクを作成する
VPC リンクを作成するには、以下のコマンドを使用します。VPC リンクを作成するには、関連するすべてのリソースが同じ AWS アカウントによって所有されている必要があります。
aws apigatewayv2 create-vpc-link --name
MyVpcLink
\ --subnet-idssubnet-aaaa
subnet-bbbb
\ --security-group-idssg1234
sg5678
注記
VPC リンクは変更できません。VPC リンクを作成した後は、そのサブネットやセキュリティグループを変更することはできません。
AWS CLI を使用して VPC リンクを削除する
次のコマンドを使用して、VPC リンクを削除します。
aws apigatewayv2 delete-vpc-link --vpc-link-id
abcd123
リージョン別の利用可能性
HTTP API の VPC リンクは、次のリージョンとアベイラビリティーゾーンでサポートされています。
リージョン名 | リージョン | サポートされているアベイラビリティーゾーン |
---|---|---|
米国東部(オハイオ) | us-east-2 |
use2-az1、use2-az2、use2-az3 |
米国東部 (バージニア北部) | us-east-1 |
use1-az1、use1-az2、use1-az4、use1-az5、use1-az6 |
米国西部(北カリフォルニア) | us-west-1 |
usw1-az1、usw1-az3 |
米国西部(オレゴン) | us-west-2 |
usw2-az1、usw2-az2、usw2-az3、usw2-az4 |
アジアパシフィック (香港) | ap-east-1 |
ape1-az2、ape1-az3 |
アジアパシフィック (ムンバイ) | ap-south-1 |
aps1-az1、aps1-az2、aps1-az3 |
アジアパシフィック (ソウル) | ap-northeast-2 |
apne2-az1、apne2-az2、apne2-az3 |
アジアパシフィック (シンガポール) | ap-southeast-1 |
apse1-az1、apse1-az2、apse1-az3 |
アジアパシフィック (シドニー) | ap-southeast-2 |
apse2-az1、apse2-az3、apse2-az2 |
アジアパシフィック (東京) | ap-northeast-1 |
apne1-az1、apne1-az2、apne1-az4 |
カナダ (中部) | ca-central-1 |
cac1-az1、cac1-az2 |
欧州 (フランクフルト) | eu-central-1 |
euc1-az1、euc1-az2、euc1-az3 |
欧州 (アイルランド) | eu-west-1 |
euw1-az1、euw1-az2、euw1-az3 |
欧州 (ロンドン) | eu-west-2 |
euw2-az1、euw2-az2、euw2-az3 |
欧州 (パリ) | eu-west-3 |
euw3-az1、euw3-az3 |
欧州 (ストックホルム) | eu-north-1 |
eun1-az1、eun1-az2、eun1-az3 |
中東 (バーレーン) | me-south-1 |
mes1-az1、mes1-az2、mes1-az3 |
南米(サンパウロ) | sa-east-1 |
sae1-az1、sae1-az2、sae1-az3 |
AWS GovCloud (米国西部) | us-gov-west-1 |
usgw1-az1、usgw1-az2、usgw1-az3 |