Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway

Der folgende Befehl create-domain-name erstellt einen benutzerdefinierten Domainnamen:

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 \
    --routing-mode ROUTING_RULE_ONLY

Die Ausgabe sieht wie folgt aus:

{
    "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"
        }
        "RoutingMode": "ROUTING_RULE_ONLY"
    ]
}

Der Eigenschaftswert DomainNameConfigurations gibt den Hostnamen der regionalen API zurück. Sie müssen einen DNS-Datensatz erstellen, der Ihren benutzerdefinierten Domainnamen auf diesen regionalen Domainnamen verweist. Dadurch wird der an den benutzerdefinierten Domainnamen gebundene Datenverkehr an den Hostnamen dieser regionalen API weitergeleitet.

Der folgende create-routing-rule-Befehl erstellt eine Auffang-Routing-Regel:

aws apigatewayv2 create-routing-rule \
  --domain-name 'regional.example.com' \
  --priority 100 \
  --conditions  \
  --actions '[{
    "InvokeApi": {
      "ApiId": "a1b2c3",
      "Stage": "prod"
    }
  }]'

Wenn Sie hierfür die AWS Management Console verwenden möchten, lesen Sie die Route-53-Dokumentation zum Thema Konfiguration von Route 53 zur Weiterleitung von Datenverkehr an API Gateway.

Wenn Sie Ihre DNS-Datensätze so konfigurieren möchten, dass der regionale benutzerdefinierte Domainname seinem Hostnamen in der ID der vorgegebenen gehosteten Zone zugewiesen wird, erstellen Sie zunächst eine JSON-Datei, die die Konfiguration für die Einrichtung eines DNS-Datensatzes für den regionalen Domainnamen enthält.

Die folgende Datei setup-dns-record.json zeigt, wie Sie einen DNS-A-Datensatz erstellen, um einen regionalen benutzerdefinierten Domainnamen (regional.example.com) seinem regionalen Hostnamen (d-numh1z56v6.execute-api.us-west-2.amazonaws.com) zuweisen, der im Rahmen der benutzerdefinierten Domainnamenerstellung bereitgestellt wurde. Die Eigenschaften DNSName und HostedZoneId von AliasTarget können die Werte regionalDomainName und regionalHostedZoneId des benutzerdefinierten Domainnamens entsprechend annehmen. Sie können die regionalen IDs der gehosteten Route 53-Zone auch in Amazon API Gateway-Endpunkte und -Kontingente abrufen.

{
  "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
        }
      }
    }
  ]
}

Der Befehl change-resource-record-sets zeigt, wie Sie einen DNS-Datensatz für Ihren regionalen benutzerdefinierten Domainnamen erstellen:

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

Ersetzen Sie die hosted-zone-id durch die Route-53-Hosted-Zone-ID des DNS-Datensatzes, die in Ihrem Konto eingerichtet wurde. Der change-batch-Parameterwert verweist auf eine JSON-Datei (setup-dns-record.json) in einem Ordner (path/to/your).