REST API에 대한 사용자 지정 도메인 이름 설정

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

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

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

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

URL의 호스트 이름 부분(즉, api-id.execute-api.region.amazonaws.com)은 API 엔드포인트를 가리킵니다. 기본 API 엔드포인트는 기억하기가 어려우며 사용자에게 친숙하지 않을 수 있습니다.

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

https://api.example.com/myservice

참고

리전 사용자 지정 도메인은 REST API 및 HTTP API와 연결될 수 있습니다. API Gateway 버전 2 API를 사용하여 REST API에 대한 리전 사용자 지정 도메인 이름을 생성하고 관리할 수 있습니다.

사용자 지정 도메인 이름은 프라이빗 API에 사용할 수 없습니다.

해당 REST API에서 지원하는 최소 TLS 버전을 선택할 수 있습니다. REST API의 경우 TLS 1.2 또는 TLS 1.0을 선택할 수 있습니다.

도메인 이름 등록

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

API Gateway에서 사용자 지정 도메인 이름을 생성한 후에는 DNS 공급자의 리소스 레코드를 생성하거나 업데이트하여 API 엔드포인트에 매핑해야 합니다. 이렇게 매핑하지 않으면 사용자 지정 도메인 이름이 목적지인 API 요청은 API Gateway에 도달할 수 없습니다.

참고

엣지에 최적화된 사용자 지정 도메인 이름은 특정 리전에서 생성되고 특정 AWS 계정이 소유합니다. 리전 또는 AWS 계정 간에 이러한 사용자 지정 도메인 이름을 이동하려면 기존 CloudFront 배포를 삭제하고 새 배포를 생성해야 합니다. 새 사용자 지정 도메인 이름을 사용할 수 있게 될 때까지 프로세스는 약 30분 정도 걸릴 수 있습니다. 자세한 내용은 CloudFront 배포 업데이트를 참조하세요.

에지 최적화 사용자 지정 도메인 이름

엣지 최적화 API를 배포하면 API Gateway는 Amazon CloudFront 배포와 DNS 레코드를 설정하여 API 도메인 이름을 CloudFront 배포 도메인 이름에 매핑합니다. 그러면 API에 대한 요청은 매핑된 CloudFront 배포를 통해 API Gateway로 라우팅됩니다.

엣지 최적화된 API에 대한 사용자 지정 도메인 이름을 생성하면 API Gateway는 CloudFront 배포를 설정합니다. 하지만 사용자 지정 도메인 이름을 CloudFront 배포 도메인 이름에 매핑하려면 DNS 레코드를 설정해야 합니다. 이 매핑은 매핑된 CloudFront 배포를 통해 API Gateway에 라우팅될 사용자 지정 도메인 이름에 바인딩된 API 요청에 사용됩니다. 또한 사용자 지정 도메인 이름에 대한 인증서를 제출해야 합니다.

참고

API Gateway가 생성한 CloudFront 배포는 API Gateway와 연계된 리전별 계정이 소유합니다. CloudWatch Logs에서 이러한 CloudFront 배포를 생성하고 업데이트하는 작업을 추적할 때는 이 API Gateway 계정 ID를 사용해야 합니다. 자세한 내용은 CloudTrail에서 사용자 지정 도메인 이름 생성 로그 단원을 참조하세요.

엣지 최적화 사용자 지정 도메인 이름을 설정하거나 해당 인증서를 업데이트하려면 CloudFront 배포를 업데이트할 수 있는 권한이 있어야 합니다.

액세스 권한을 제공하려면 사용자, 그룹 또는 역할에 권한을 추가합니다.

• AWS IAM Identity Center의 사용자 및 그룹:

  권한 세트를 생성합니다. AWS IAM Identity Center 사용 설명서의 권한 세트 생성의 지침을 따르세요.

• 자격 증명 공급자를 통해 IAM에서 관리되는 사용자:

  아이덴티티 페더레이션을 위한 역할을 생성합니다. IAM 사용 설명서의 서드 파티 자격 증명 공급자의 역할 만들기(연합)의 지침을 따르세요.

• IAM 사용자:

  • 사용자가 맡을 수 있는 역할을 생성합니다. IAM 사용 설명서에서 IAM 사용자의 역할 생성의 지침을 따르세요.

  • (권장되지 않음) 정책을 사용자에게 직접 연결하거나 사용자를 사용자 그룹에 추가합니다. IAM 사용 설명서에서 사용자(콘솔)에 권한 추가의 지침을 따르세요.

CloudFront 배포를 업데이트하려면 다음 권한이 필요합니다.

{
    "Version": "2012-10-17",
    "Statement": [
         {
            "Sid": "AllowCloudFrontUpdateDistribution",
            "Effect": "Allow",
            "Action": [
                "cloudfront:updateDistribution"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

API Gateway는 CloudFront 배포에서 SNI(Server Name Indication)를 활용하여 엣지 최적화 사용자 지정 도메인 이름을 지원합니다. 필요한 인증서 형식 및 인증서 키 길이의 최대 크기를 포함하여 CloudFront 배포에서 사용자 지정 도메인 이름을 사용하는 방법에 대한 자세한 내용은 Amazon CloudFront 개발자 안내서의 대체 도메인 이름 및 HTTPS 사용을 참조하세요.

사용자 지정 도메인 이름을 API의 호스트 이름으로 설정하려면 API 소유자인 사용자가 사용자 지정 도메인 이름에 대한 SSL/TLS 인증서를 제공해야 합니다.

엣지에 최적화된 사용자 지정 도메인 이름에 대한 인증서를 제공하기 위해 ACM에서 새 인증서를 생성하거나 us-east-1 리전(미국 동부(북부 버지니아))의 타사 인증 기관에서 발행한 인증서를 ACM으로 가져오도록 AWS Certificate Manager(ACM)에 요청할 수 있습니다.

리전 사용자 지정 도메인 이름

리전 API에 대해 사용자 지정 도메인 이름을 생성하면 API Gateway는 해당 API에 대해 리전 도메인 이름을 생성합니다. DNS 레코드를 설정하여 사용자 지정 도메인 이름이 리전 도메인 이름을 가리키도록 해야 합니다. 또한 사용자 지정 도메인 이름에 대한 인증서를 제출해야 합니다.

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

와일드카드 사용자 지정 도메인 이름을 사용하면 기본 할당량을 초과하지 않고 거의 무제한 수의 도메인 이름을 지원할 수 있습니다. 예를 들어 각 고객에게 고유한 도메인 이름인 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 계정에서 와일드카드 사용자 지정 도메인 이름과 충돌하는 사용자 지정 도메인 이름을 만든 경우에는 와일드카드 사용자 지정 도메인 이름을 생성할 수 없습니다. 예를 들어 계정 A에서 a.example.com가 생성된 경우, 계정 B는 와일드카드 사용자 지정 도메인 이름 *.example.com을 생성할 수 없습니다.

계정 A와 계정 B가 한 소유자를 공유하는 경우 AWS 지원 센터에 문의하여 예외를 요청할 수 있습니다.

사용자 지정 도메인 이름에 대한 인증서

중요

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

ACM을 지원하는 리전에서 사용자 지정 도메인 이름에 대한 인증서를 제공하려면 ACM에 인증서를 요청해야 합니다. ACM을 지원하지 않는 리전에서 리전 사용자 지정 도메인 이름에 대한 인증서를 제공하려면 해당 리전의 API Gateway로 인증서를 가져와야 합니다.

SSL/TLS 인증서를 가져오려면 PEM 형식의 SSL/TLS 인증서 본문, 해당하는 프라이빗 키 및 사용자 지정 도메인 이름에 대한 인증서 체인을 제공해야 합니다. ACM에 저장된 각 인증서는 ARN으로 식별됩니다. 해당 ARN을 참조하기만 하면 도메인 이름에 대해 AWS에서 관리하는 인증서를 사용할 수 있습니다.

ACM을 사용하면 API에 대한 사용자 지정 도메인 이름을 간편하게 설정하고 사용할 수 있습니다. 지정된 도메인 이름에 대한 인증서를 생성하거나 인증서를 가져오고, API Gateway에서 ACM이 제공한 인증서의 ARN을 사용하여 도메인 이름을 설정한 다음, 사용자 지정 도메인 이름 아래의 기본 경로를 API의 배포된 단계에 매핑합니다. ACM에서 발행한 인증서를 사용하면 프라이빗 키 같은 민감한 인증서 세부 정보의 공개를 걱정할 필요가 없습니다.

주제

• AWS Certificate Manager에서 인증서 준비하기
• API Gateway에서 사용자 지정 도메인에 대한 보안 정책 선택
• 에지 최적화 사용자 지정 도메인 이름 생성
• API Gateway에서 리전 사용자 지정 도메인 이름 설정
• 사용자 지정 도메인 이름을 다른 API 엔드포인트로 마이그레이션
• REST API에 대한 API 매핑 작업
• REST API에 대한 기본 엔드포인트 비활성화
• DNS 장애 조치에 대한 사용자 지정 상태 확인 구성