在閘道中設定地區自訂API網域名稱

下列create-domain-name指令可用來建立自訂網域名稱：

aws apigatewayv2 create-domain-name \ 
    --domain-name 'regional.example.com' \
    --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

如果成功，呼叫會傳回類似如下的結果：

{
    "ApiMappingSelectionExpression": "$request.basepath",
    "DomainName": "regional.example.com",
    "DomainNameConfigurations": [
        {
            "ApiGatewayDomainName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com",
            "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
            "DomainNameStatus": "AVAILABLE",
            "EndpointType": "REGIONAL",
            "HostedZoneId": "Z2OJLYMUO9EFXC",
            "SecurityPolicy": "TLS_1_2"
        }
    ]
}

DomainNameConfigurations屬性值返回區域API的主機名。您必須建立DNS記錄，將您的自訂網域名稱指向此區域網域名稱。這可讓繫結至自訂網域名稱的流量路由至此地區API的主機名稱。

若要使用 AWS Management Console，請遵循 Route 53 說明文件，了解如何設定 Route 53 將流量路由傳送至API閘道。

若要設定您的DNS記錄，將地區自訂網域名稱對應至指定託管區域 ID 的主機名稱，請先建立一個JSON檔案，其中包含設定區域網域名稱DNS記錄的組態。

以下說setup-dns-record.json明如何建立DNSA記錄，將地區自訂網域名稱 (regional.example.com) 對應至其區域主機名稱 (d-numh1z56v6.execute-api.us-west-2.amazonaws.com)，做為建立自訂網域名稱的一部分。DNSName 的 HostedZoneId 與 AliasTarget 屬性可分別接受自訂網域名稱的 regionalDomainName 與 regionalHostedZoneId 值。您也可以IDs在 Amazon API 閘道端點和配額中取得區域 Route 53 託管區域。

{
  "Changes": [
    {
      "Action": "CREATE",
      "ResourceRecordSet": {
        "Name": "regional.example.com",
        "Type": "A",
        "AliasTarget": {
          "DNSName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com",
          "HostedZoneId": "Z2OJLYMUO9EFXC",
          "EvaluateTargetHealth": false
        }
      }
    }
  ]
}

以下說change-resource-record-sets明如何為您的區域自訂網域名稱建立DNS記錄：

aws route53 change-resource-record-sets \
    --hosted-zone-id Z2OJLYMUO9EFXC \
    --change-batch file://path/to/your/setup-dns-record.json

將hosted-zone-id您帳戶中DNS記錄集的 Route 53 託管區域 ID 取代。change-batch參數值指向一個JSON檔案 (setup-dns-record.json）在文件夾中（path/to/your).

以下create-api-mapping命令可用於創建基本路徑映射：

aws apigatewayv2 create-api-mapping \
    --domain-name 'regional.example.com' \
    --api-mapping-key 'myApi' \
    --api-id abcd1234 \
    --stage 'test'

因此，URL使用階段中部署的自訂網域名稱API的基礎會變成https://regional.example.com/myAPI。