x-amazon-apigateway-endpoint-Konfigurationsobjekt

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.

Eigenschaften
Name der Eigenschaft	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-Endpunkt aufrufen. Wenn Sie erzwingen möchten, dass Kunden einen benutzerdefinierten Domänennamen verwenden, um Ihre API aufzurufen, geben Sie a true.
vpcEndpointIds	Ein Array von String	Eine Liste von VpcEndpoint Kennungen, anhand derer Route-53-Aliasdatensätze für eine REST-API erstellt werden. Wird nur für REST-APIs vom Endpunkttyp PRIVATE unterstützt.

x-amazon-apigateway-endpoint-Konfigurationsbeispiele

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
}