Arbeiten mit API-Zuweisungen für WebSocket-APIs
Sie verwenden API-Zuweisungen, um API-Stufen mit einem benutzerdefinierten Domain-Namen zu verbinden. Nachdem Sie einen Domain-Namen erstellt und DNS-Einträge konfiguriert haben, verwenden Sie API-Mappings, um Datenverkehr über Ihren benutzerdefinierten Domain-Namen an Ihre APIs zu senden.
Ein API-Mapping gibt eine API, eine Phase und optional einen Pfad an, die für das Mapping verwendet werden sollen. Sie können beispielsweise die production-Phase einer API in wss://api.example.com/orders abbilden.
Bevor Sie eine API-Zuweisung erstellen, benötigen Sie eine API, eine Phase und einen benutzerdefinierten Domain-Namen. Weitere Informationen zum Erstellen eines benutzerdefinierten Domain-Namens finden Sie unter Einrichten eines regionalen benutzerdefinierten Domänennamens in API Gateway.
Restrictions
-
In einer API-Zuweisung müssen sich der benutzerdefinierte Domänenname und die zugeordneten APIs im selben AWS-Konto befinden.
-
API-Mappings dürfen nur Buchstaben, Zahlen und die folgenden Zeichen enthalten:
$-_.+!*'(). -
Die maximale Länge für den Pfad in einer API-Zuweisung beträgt 300 Zeichen.
-
Sie können WebSocket-APIs nicht demselben benutzerdefinierten Domain-Namen wie dem einer HTTP-API oder REST-API zuweisen.
Ein API-Mapping erstellen
Um ein API-Mapping zu erstellen, müssen Sie zuerst einen benutzerdefinierten Domain-Namen, eine API und eine Phase erstellen. Informationen zum Erstellen eines benutzerdefinierten Domain-Namens finden Sie unter Einrichten eines regionalen benutzerdefinierten Domänennamens in API Gateway.
