x-amazon-apigateway-endpoint-objet de configuration - APIPasserelle Amazon
x-amazon-apigateway-endpoint-exemples de configuration

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

x-amazon-apigateway-endpoint-objet de configuration

Spécifie les détails de la configuration du point de terminaison pour unAPI. Cette extension est une propriété étendue de l'objet Open API Operation. Cet objet doit être présent dans les extensions fournisseur de premier niveau pour Swagger 2.0. Pour Open API 3.0, il doit être présent sous les extensions fournisseur de l'objet Server.

Nom de la propriété Type Description
disableExecuteApiEndpoint Booléen

Spécifie si les clients peuvent vous appeler API en utilisant le point de execute-api terminaison par défaut. Par défaut, les clients peuvent vous appeler API avec le point de https://{api_id}.execute-api.{region}.amazonaws.com terminaison par défaut. Pour obliger les clients à utiliser un nom de domaine personnalisé pour appeler votre nom de domaineAPI, spécifieztrue.
vpcEndpointIds Tableau d'éléments String

Une liste d' VpcEndpoint identifiants par rapport auxquels créer des enregistrements d'alias Route 53 pour un RESTAPI. Il n'est pris en charge que pour REST APIs le type de PRIVATE point de terminaison.

x-amazon-apigateway-endpoint-exemples de configuration

L'exemple suivant associe les VPC points de terminaison spécifiés au RESTAPI.

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

L'exemple suivant désactive le point de terminaison par défaut pour unAPI.

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