API Gateway에서 HTTP API에 대한 프라이빗 통합 생성

프라이빗 통합을 사용하면 VPC의 프라이빗 리소스(예: Application Load Balancer 또는 Amazon ECS 컨테이너 기반 애플리케이션)와의 API 통합을 생성할 수 있습니다.

프라이빗 통합을 사용하여 VPC 외부의 클라이언트가 액세스할 수 있도록 VPC에 리소스를 노출할 수 있습니다. API Gateway가 지원하는 권한 부여 방법을 사용하여 API에 대한 액세스를 제어할 수 있습니다.

프라이빗 통합을 생성하려면 먼저 VPC 링크를 생성해야 합니다. VPC 링크에 대한 자세한 내용은 API Gateway에서 HTTP API에 대한 VPC 링크 설정 단원을 참조하세요 .

VPC 링크를 생성한 후에는 Application Load Balancer, Network Load Balancer 또는 AWS Cloud Map 서비스에 등록된 리소스에 연결되는 프라이빗 통합을 설정할 수 있습니다.

프라이빗 통합을 생성하려면 모든 리소스를 동일한 AWS 계정(로드 밸런서 또는 AWS Cloud Map 서비스, VPC 링크 및 HTTP API 포함)이 소유해야 합니다.

기본적으로 프라이빗 통합 트래픽은 HTTP 프로토콜을 사용합니다. HTTPS를 사용하기 위해 프라이빗 통합 트래픽이 필요한 경우, tlsConfig를 지정할 수 있습니다. AWS Management Console을 사용하여 이 작업을 수행하려면 프라이빗 통합을 생성할 때 고급 설정을 선택한 다음 보안 서버 이름을 입력합니다.

참고

프라이빗 통합의 경우 API Gateway에서 백엔드 리소스에 대한 요청에 API 엔드포인트의 스테이지 부분을 포함합니다. 예를 들어 API test 스테이지에 대한 요청은 프라이빗 통합 요청에 test/route-path를 포함합니다. 백엔드 리소스에 대한 요청에서 단계 이름을 제거하려면 파라미터 매핑을 사용하여 요청 경로를 $request.path에 덮어씁니다.

Application Load Balancer 또는 Network Load Balancer를 사용하여 프라이빗 통합 생성

프라이빗 통합을 생성하기 전에 VPC 링크를 생성해야 합니다. VPC 링크에 대한 자세한 내용은 API Gateway에서 HTTP API에 대한 VPC 링크 설정 단원을 참조하세요 .

Application Load Balancer 또는 Network Load Balancer에서 프라이빗 통합을 생성하려면 HTTP 프록시 통합을 생성하고, 사용할 VPC 링크를 지정하고, 로드 밸런서의 리스너 ARN을 제공합니다.

다음 명령을 사용하여 VPC 링크를 통해 로드 밸런서에 연결하는 프라이빗 통합을 생성합니다.

aws apigatewayv2 create-integration --api-id api-id --integration-type HTTP_PROXY \
    --integration-method GET --connection-type VPC_LINK \
    --connection-id VPC-link-ID \
    --integration-uri arn:aws:elasticloadbalancing:us-east-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65
    --payload-format-version 1.0

AWS Cloud Map 서비스 검색을 사용하여 프라이빗 통합 생성

프라이빗 통합을 생성하기 전에 VPC 링크를 생성해야 합니다. VPC 링크에 대한 자세한 내용은 API Gateway에서 HTTP API에 대한 VPC 링크 설정 단원을 참조하세요 .

AWS Cloud Map와의 통합을 위해 API Gateway는 DiscoverInstances를 사용하여 리소스를 식별합니다. 쿼리 파라미터를 사용하여 특정 리소스를 대상으로 지정할 수 있습니다. 등록된 리소스의 속성에는 IP 주소와 포트가 포함되어야 합니다. API Gateway는 DiscoverInstances에서 반환된 정상 리소스에 요청을 분산합니다. 자세한 내용은 AWS Cloud Map API 참조의 DiscoverInstances를 참조하세요.

참고

Amazon ECS를 사용하여 AWS Cloud Map의 항목을 채우는 경우 Amazon ECS 서비스 검색과 함께 SRV 레코드를 사용하도록 Amazon ECS 작업을 구성하거나 Amazon ECS Service Connect를 활성화해야 합니다. 자세한 내용은 Amazon Elastic Container Service 개발자 안내서의 서비스 상호 연결을 참조하세요.

AWS Cloud Map과의 프라이빗 통합을 생성하려면 HTTP 프록시 통합을 생성하고, 사용할 VPC 링크를 지정하고, AWS Cloud Map 서비스의 ARN을 제공합니다.

다음 명령을 사용하여 AWS Cloud Map 서비스 검색을 통해 리소스를 식별하는 프라이빗 통합을 생성합니다.

aws apigatewayv2 create-integration --api-id api-id --integration-type HTTP_PROXY  \
    --integration-method GET --connection-type VPC_LINK \
    --connection-id VPC-link-ID \
    --integration-uri arn:aws:servicediscovery:us-east-2:123456789012:service/srv-id?stage=prod&deployment=green_deployment
    --payload-format-version 1.0