API Gateway API의 사용자 지정 도메인 이름을 설정하려면 어떻게 해야 하나요?

4분 분량

기본 URL 대신 Amazon API Gateway API에 사용자 지정 도메인 이름을 사용하고 싶습니다. 어떻게 설정하나요?

간략한 설명

API Gateway API용으로 만들 수 있는 사용자 지정 도메인 이름에는 다음의 두 가지 유형이 있습니다. 리전별 또는 (REST API의 경우에만) 엣지 최적화.

참고: 사용자 지정 도메인 이름은 프라이빗 API에 지원되지 않습니다.

API Gateway API에 대한 사용자 지정 도메인 이름을 설정하려면 다음과 같이 하세요.

SSL/TLS 인증서를 요청하거나 가져옵니다.
REST API, HTTP API 또는 WebSocket API에 대한 사용자 지정 도메인 이름을 만듭니다.
새 사용자 지정 도메인 이름을 사용해 API를 호출하여 설정을 테스트합니다.

다음은 리전별 및 엣지에 최적화된 사용자 지정 도메인 이름의 몇 가지 주요 차이점입니다.

대상 엔드포인트 차이점

리전별 사용자 지정 도메인 이름은 리전 API 엔드포인트를 사용합니다.

엣지 최적화 사용자 지정 도메인 이름은 Amazon CloudFront 배포를 사용합니다.

SSL/TLS 인증서 차이점

리전별 사용자 지정 도메인 이름은 API와 동일한 AWS 리전에 있는 SSL/TLS 인증서를 사용해야 합니다.

엣지 최적화 사용자 지정 도메인 이름은 다음 리전에 있는 인증서를 사용해야 합니다. 미국 동부(버지니아 북부)(us-east-1).

사용자 지정 도메인 이름의 차이점

리전별 사용자 지정 도메인 이름은 다른 AWS 리전에 있는 다른 리전별 사용자 지정 도메인 이름과 공유할 수 있습니다.

엣지에 최적화된 사용자 지정 도메인 이름은 고유하며 둘 이상의 CloudFront 배포와 연결할 수 없습니다.

도메인 이름 매핑의 차이점

WebSocket API의 리전별 사용자 지정 도메인 이름은 REST API 또는 HTTP API에 매핑할 수 없습니다. 그러나 리전별 사용자 지정 도메인은 REST API 및 HTTP API와 연결할 수 있습니다.

REST API의 경우 엣지 최적화 및 리전별 사용자 지정 도메인 이름 모두 엣지 최적화 API 엔드포인트, 리전 API 엔드포인트 또는 둘 다에 대한 매핑을 가질 수 있습니다.

WebSocket API 및 HTTP API의 경우 TLS 1.2만이 지원되는 유일한 TLS 버전입니다.

해결 방법

SSL/TLS 인증서 요청 또는 가져오기

API의 사용자 정의 도메인 이름을 생성하기 전에 다음 중 하나를 수행해야 합니다.

AWS Certificate Manager(ACM)에서 SSL/TLS 인증서를 요청합니다.
-또는-
SSL/TLS 인증서를 ACM으로 가져옵니다.

참고: 자세한 내용을 보려면 AWS Certificate Manager에서 인증서 준비하기를 참조하세요.

인증서를 요청하거나 가져올 때 다음 요구 사항에 유의하세요.

도메인 유효성 검사를 통과하려면 인증서에 사용자 지정 도메인 이름을 대체 도메인 이름으로 포함해야 합니다.
참고: CloudFront 배포(엣지 최적화 사용자 지정 도메인 이름의 경우)의 검증 검사에 대한 자세한 내용을 보려면 Amazon CloudFront에서 도메인 보안 지속적 강화를 참조하세요. 리전별 사용자 지정 도메인 이름에 대해서도 유사한 검증 항목이 있습니다.
엣지 최적화 사용자 지정 도메인 이름의 경우 ACM 인증서는 다음 리전에 있어야 합니다. 미국 동부(버지니아 북부)(us-east-1).
리전별 사용자 지정 도메인 이름의 경우 ACM 인증서는 API와 동일한 리전에 있어야 합니다.

REST API, HTTP API 또는 WebSocket API의 사용자 지정 도메인 이름 생성

REST API의 경우 REST API의 사용자 지정 도메인 이름 설정의 지침을 따릅니다.

HTTP API의 경우 HTTP API의 사용자 지정 도메인 이름 설정의 지침을 따릅니다.

WebSocket API의 경우 WebSocket API에 대한 사용자 지정 도메인 이름 설정하기의 지침을 따릅니다.

API Gateway API로 트래픽 라우팅

Amazon Route 53을 사용하여 사용자 지정 도메인으로 트래픽을 라우팅합니다. 이렇게 하면 사용자가 도메인을 방문할 때 액세스할 수 있는 리소스를 더 잘 제어할 수 있습니다.

Route 53을 구성하여 API 게이트웨이 엔드포인트로 트래픽 라우팅하기의 지침을 따르세요.

Route 53을 구성할 때는 퍼블릭 호스트 영역 또는 프라이빗 호스트 영역을 만들어야 합니다. 사용자가 사용할 수 있도록 하려는 리소스가 있는 인터넷 연결 애플리케이션의 경우 퍼블릭 호스트 영역을 선택하세요. 자세한 내용을 보려면 호스트 영역으로 작업하기를 참조하세요.
Route 53은 레코드를 사용하여 도메인에 대한 트래픽이 라우팅되는 위치를 결정합니다. 별칭 레코드는 AWS 리소스에 대한 DNS 쿼리를 더 쉽게 제공하는 반면, CNAME(별칭이 아닌) 레코드는 DNS 쿼리를 AWS 리소스 외부로 리디렉션할 수 있습니다. 자세한 내용을 보려면 별칭 레코드와 비별칭 레코드 중에서 선택을 참조하세요.

새 사용자 지정 도메인 이름을 사용하여 API를 호출하여 설정을 테스트합니다.

1. 사용자 지정 도메인 이름을 만들 때 지정한 기본 경로 매핑을 사용하여 도메인 이름에서 curl 명령을 실행합니다.
참고: curl에 대한 자세한 내용을 보려면 curl 프로젝트 웹사이트를 참조하세요.

2. 사용자 지정 도메인 이름에 대한 응답이 API 단계 URL을 호출할 때 받은 응답과 동일한지 확인합니다.