리전 사용자 지정 도메인 이름을 사용하여 사용자 친화적인 API 기본 URL을 생성합니다. 리전 사용자 지정 도메인 이름을 사용하면 HTTP 및 REST API 스테이지를 동일한 사용자 지정 도메인 이름에 매핑하고 상호 TLS 인증을 사용할 수 있습니다.
고려 사항
다음은 리전 사용자 지정 도메인 이름에 대한 고려 사항입니다.
-
리전별 ACM 인증서를 제공해야 합니다. 인증서는 API와 동일한 리전에 있어야 합니다. 사용자 지정 도메인 이름 인증서 생성 또는 업로드에 대한 자세한 내용은 AWS Certificate Manager에서 인증서 준비를 참조하세요.
-
ACM 인증서로 리전 사용자 지정 도메인 이름을 생성(또는 마이그레이션)하면 API Gateway는 해당 계정에 서비스 연결 역할을 생성합니다. 서비스 연결 역할은 ACM 인증서를 해당 리전 엔드포인트에 연결하는 데 필요합니다. 그 역할의 이름은 AWSServiceRoleForAPIGateway이고 이 역할에는 APIGatewayServiceRolePolicy 관리형 정책이 연결됩니다. 서비스 연결 역할을 사용하는 방법에 대한 자세한 내용은 서비스 연결 역할 사용을 참조하세요.
-
리전 사용자 지정 도메인 이름을 생성한 후에는 DNS 레코드를 생성하여 사용자 지정 도메인 이름을 리전 도메인에 연결해야 합니다. 이렇게 하면 목적지가 사용자 지정 도메인 이름인 트래픽이 API의 리전 호스트 이름으로 라우팅됩니다.
DNS 레코드는 CNAME 또는 A 별칭 레코드일 수 있습니다. Route 53을 DNS 공급자로 사용하는 경우 A 별칭 레코드를 생성합니다. 타사 DNS 공급자를 사용하는 경우 CNAME 레코드를 사용합니다. CNAME 레코드를 사용하고 프라이빗 API에 대해 프라이빗 DNS가 활성화된 API Gateway 인터페이스 VPC 엔드포인트를 생성하는 경우 프라이빗 API를 호스팅하는 VPC 내에서 사용자 지정 도메인 이름을 확인할 수 없습니다.
리전 사용자 지정 도메인 이름 생성
다음 절차는 리전 사용자 지정 도메인 이름을 생성하는 방법을 보여 줍니다. 이 절차를 완료한 후 API의 스테이지를 사용자 지정 도메인 이름에 매핑하는 기본 경로 매핑을 생성합니다.
https://console.aws.amazon.com/apigateway
에서 API Gateway 콘솔에 로그인합니다. -
기본 탐색 창에서 사용자 지정 도메인 이름을 선택합니다.
-
생성을 선택합니다.
-
도메인 이름에 도메인 이름을 입력합니다.
-
최소 TLS 버전에서 버전을 선택합니다.
-
엔드포인트 구성 아래의 API 엔드포인트 유형에서 리전을 선택합니다.
-
ACM 인증서를 선택합니다. 인증서는 API와 동일한 리전에 있어야 합니다.
-
생성(Create)을 선택합니다.
지역 사용자 지정 도메인 이름에 대한 기본 경로 매핑을 생성합니다.
사용자 지정 도메인 이름을 생성한 후 기본 경로 매핑을 생성하여 API를 사용자 지정 도메인 이름에 매핑합니다. 예를 들어 myApi
의 API 매핑 키를 사용하여 abc123
의 API ID에 대한 스테이지 test
를 사용자 지정 도메인 이름 regional.example.com
에 매핑할 수 있습니다. 이렇게 하면 API https://abcd1234.execute-api.us-west-2.amazonaws.com/test
가 https://regional.example.com/myApi
에 매핑됩니다.
https://console.aws.amazon.com/apigateway
에서 API Gateway 콘솔에 로그인합니다. -
사용자 지정 도메인 이름을 선택합니다.
-
API 매핑 구성을 선택합니다.
-
Add new mapping(새 매핑 추가)을 선택합니다.
-
매핑에 대한 API, 스테이지 및 경로를 지정합니다.
-
Save(저장)를 선택합니다.
리전 사용자 지정 도메인 이름을 사용하면 https://regional.example.com/orders/v1/items/123
과 같이 여러 수준의 API 매핑을 생성할 수 있습니다. HTTP 및 REST API 스테이지를 동일한 사용자 지정 도메인 이름에 매핑할 수 있습니다. 자세한 내용은 API 스테이지를 REST API에 대한 사용자 지정 도메인 이름에 매핑 단원을 참조하십시오.
리전 사용자 지정 도메인 이름에 대한 DNS 레코드 생성
사용자 지정 도메인 이름을 생성하고 기본 경로 매핑을 생성한 후 DNS 레코드를 생성하여 사용자 지정 도메인 이름을 새로 만든 리전 도메인 이름에 연결합니다.
AWS Management Console을 사용하려면 Route 53 설명서에 따라 트래픽을 API Gateway로 라우팅하도록 Route 53를 구성합니다.