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
Eigenschaftenname | Typ | Beschreibung |
---|---|---|
disableExecuteApiEndpoint |
Boolesch |
Gibt an, ob Clients Ihre API mithilfe des |
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 |
ipAddressType |
string |
Die IP-Adresstypen, die eine HTTP-API aufrufen können. Verwenden Sie |
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" }