API Gateway의 퍼블릭 REST API에 대한 사용자 지정 도메인 이름

사용자 지정 도메인 이름은 API 사용자에게 제공할 수 있는 더 간단하고 직관적인 URL입니다.

API를 배포한 후 사용자 및 사용자 고객은 다음 형식의 기본 URL을 사용하여 API를 호출할 수 있습니다.

https://api-id.execute-api.region.amazonaws.com/stage

여기서 api-id는 API Gateway에서 생성되고 region은 AWS 리전이며 stage는 API를 배포할 때 사용자가 지정합니다.

URL의 호스트 이름 부분(즉, api-id.execute-api.region.amazonaws.com)은 API 엔드포인트를 가리킵니다. 기본 API 엔드포인트는 임의로 생성되므로 기억하기가 어려우며 사용자 친화적이지 않습니다.

사용자 지정 도메인 이름을 사용하면 API의 호스트 이름을 설정하고 기본 경로(예: myservice)를 선택하여 대체 URL을 API에 매핑할 수 있습니다. 예를 들어, 더 사용자 친화적인 API 기본 URL은 다음과 같습니다.

https://api.example.com/myservice

고려 사항

다음 고려 사항은 사용자 지정 도메인 이름 사용에 영향을 미칠 수 있습니다.

사용자 지정 도메인 이름에 대한 사전 조건

퍼블릭 또는 프라이빗 사용자 지정 도메인 이름을 생성하기 위한 사전 요구 사항은 다음과 같습니다. 프라이빗 API의 사용자 지정 도메인 이름에 대한 자세한 내용은 API Gateway의 프라이빗 API에 대한 사용자 지정 도메인 이름 섹션을 참조하세요.

도메인 이름 등록

API에 대한 사용자 지정 도메인 이름을 설정하려면 등록된 인터넷 도메인 이름이 있어야 합니다. Amazon Route 53를 사용하거나 사용자가 선택한 서드 파티 도메인 등록자를 사용하여 인터넷 도메인을 등록할 수 있습니다. 사용자 지정 도메인 이름은 하위 도메인의 이름이거나 등록된 인터넷 도메인의 루트 도메인("zone apex"라고도 함) 이름일 수 있습니다.

도메인 이름은 RFC 1035 사양을 따라야 하며 라벨당 최대 63옥텟, 총 255옥텝을 포함할 수 있습니다.

사용자 지정 도메인 이름에 대한 인증서를 지정합니다.

API에 대한 사용자 지정 도메인 이름을 설정하기 전에 ACM에서 SSL/TLS 인증서를 준비해야 합니다. 사용자 지정 도메인 이름을 생성하는 AWS 리전에서 ACM을 사용할 수 없는 경우 해당 리전의 API Gateway로 인증서를 가져와야 합니다.

SSL/TLS 인증서를 가져오려면 PEM 형식의 SSL/TLS 인증서 본문, 해당하는 프라이빗 키 및 사용자 지정 도메인 이름에 대한 인증서 체인을 제공해야 합니다.

ACM에 저장된 각 인증서는 ARN으로 식별됩니다. ACM에서 발행한 인증서를 사용하면 프라이빗 키 같은 민감한 인증서 세부 정보의 공개를 걱정할 필요가 없습니다. 해당 ARN을 참조하기만 하면 도메인 이름에 대해 AWS에서 관리하는 인증서를 사용할 수 있습니다.

애플리케이션에서 ACM 인증서를 고정하기 위해 인증서 고정(SSL 고정)을 사용하는 경우, AWS가 인증서를 갱신한 후 애플리케이션이 도메인에 연결하지 못하게 될 수 있습니다. 자세한 내용은 AWS Certificate Manager 사용 설명서의 인증서 고정 문제를 참조하세요.

와일드카드 사용자 정의 도메인 이름

와일드카드 사용자 지정 도메인 이름을 사용하면 기본 할당량을 초과하지 않고 거의 무제한 수의 도메인 이름을 지원할 수 있습니다. 예를 들어 각 고객에게 고유한 도메인 이름인 customername.api.example.com을 제공할 수 있습니다.

와일드카드 사용자 지정 도메인 이름을 생성하려면, 와일드카드(*)를 루트 도메인의 가능한 모든 하위 도메인을 나타내는 사용자 지정 도메인의 첫 번째 하위 도메인으로 지정할 수 있습니다.

예를 들어 와일드카드 사용자 정의 도메인 이름 *.example.com을 사용하면 a.example.com, b.example.com 및 c.example.com 같은 하위 도메인이 모두 동일한 도메인으로 라우팅됩니다.

와일드카드 사용자 지정 도메인 이름은 API Gateway의 표준 사용자 지정 도메인 이름과 별개의 구성을 지원합니다. 예를 들어, 단일 AWS 계정에서 *.example.com과 a.example.com가 다르게 동작하도록 구성할 수 있습니다.

$context.domainName 및 $context.domainPrefix 컨텍스트 변수를 사용하여 클라이언트가 API를 호출하는 데 사용한 도메인 이름을 확인할 수 있습니다. 컨텍스트 변수에 대해 자세히 알아보려면 API Gateway 매핑 템플릿과 액세스 로깅 변수 참조 단원을 참조하십시오.

와일드카드 사용자 지정 도메인 이름을 생성하려면 DNS 또는 이메일 검증 방법을 사용하여 검증한 ACM에서 발급한 인증서를 제공해야 합니다.

사용자 지정 도메인 이름에 대한 다음 단계

사용자 지정 도메인 이름에 대한 다음 단계는 다음과 같습니다.

사용자 지정 도메인 이름을 처음 생성하는 경우 먼저 AWS Certificate Manager에서 인증서 준비으로 시작하여 인증서를 지정한 다음 API Gateway에서 리전 사용자 지정 도메인 이름 설정로 리전 사용자 지정 도메인 이름을 생성하는 것이 좋습니다.