x-amazon-apigateway-endpoint-Konfigurationsobjekt - APIAmazon-Gateway
x-amazon-apigateway-endpoint-Konfigurationsbeispiele

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

x-amazon-apigateway-endpoint-Konfigurationsobjekt

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

Name der Eigenschaft Typ Beschreibung
disableExecuteApiEndpoint Boolesch

Gibt an, ob Clients Ihren API mithilfe des execute-api Standardendpunkts aufrufen können. Standardmäßig können Clients Ihren API mit dem https://{api_id}.execute-api.{region}.amazonaws.com Standardendpunkt aufrufen. Um zu verlangen, dass Clients einen benutzerdefinierten Domainnamen verwenden, um Ihren aufzurufenAPI, geben Sie an. true
vpcEndpointIds Ein Array von String

Eine Liste von VpcEndpoint Kennungen, anhand derer Route 53-Aliaseinträge für a erstellt werden sollen. REST API Es wird nur für REST APIs den PRIVATE Endpunkttyp unterstützt.

x-amazon-apigateway-endpoint-Konfigurationsbeispiele

Das folgende Beispiel ordnet die angegebenen VPC Endpunkte dem zu. REST API

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

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

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