x-amazon-apigateway-endpoint-configuration-Objekt - Amazon API Gateway

x-amazon-apigateway-endpoint-configuration-Objekt

Gibt Details der Endpunktkonfiguration für eine API an. Diese Erweiterung ist eine erweiterte Eigenschaft des Objekts OpenAPI-Operation. Dieses Objekt sollte in Top-Level-Anbietererweiterungen für Swagger 2.0 vorhanden sein. Für OpenAPI 3.0 sollte es unter den Anbietererweiterungen des Server-Objekts vorhanden sein.

Eigenschaftenname Typ Beschreibung
disableExecuteApiEndpoint Boolesch

Gibt an, ob Clients Ihre API mithilfe des execute-api-Standardendpunkts aufrufen können. Standardmäßig können Kunden Ihre API mit dem standardmäßigen https://{api_id}.execute-api.{region}.amazonaws.com.rproxy.govskope.ca-Endpunkt aufrufen. Wenn Sie erzwingen möchten, dass Kunden einen benutzerdefinierten Domänennamen verwenden, um Ihre API aufzurufen, geben Sie true an.

vpcEndpointIds Ein Array von String

Eine Liste von VpcEndpoint-IDs, anhand derer Route 53-Alias-Einträge für eine REST-API erstellt werden können. Wird nur für REST-APIs vom Endpunkttyp PRIVATE unterstützt.

ipAddressType string

Die IP-Adresstypen, die eine HTTP-API aufrufen können. Verwenden Sie ipv4, um IPv4-Adresstypen das Aufrufen einer HTTP-API zu ermöglichen. Verwenden Sie dualstack, um IPv4- und IPv6-Adresstypen das Aufrufen einer HTTP-API zu ermöglichen. Dies wird nur für HTTP-APIs unterstützt.

x-amazon-apigateway-endpoint-configuration-Beispiele

Im folgenden Beispiel werden die angegebenen VPC-Endpunkte der REST-API zugeordnet.

"x-amazon-apigateway-endpoint-configuration": { "vpcEndpointIds": ["vpce-0212a4ababd5b8c3e", "vpce-01d622316a7df47f9"] }

Das folgende Beispiel deaktiviert den Standardendpunkt für eine API.

"x-amazon-apigateway-endpoint-configuration": { "disableExecuteApiEndpoint": true }

Das folgende Beispiel legt den IP-Adresstyp für eine HTTP-API auf Dualstack fest.

"x-amazon-apigateway-endpoint-configuration": { "ipAddressType": "dualstack" }