View a markdown version of this page

Objet x-amazon-apigateway-endpoint-configuration - Amazon API Gateway
Exemples x-amazon-apigateway-endpoint-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.

Objet x-amazon-apigateway-endpoint-configuration

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

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

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

Liste d' VpcEndpoint identifiants permettant de créer des enregistrements d'alias Route 53 pour une API REST. Ce paramètre est uniquement pris en charge pour le type de point de terminaison PRIVATE des API REST.
ipAddressType string

Types d’adresses IP pouvant invoquer une API HTTP. Utilisez ipv4 pour autoriser les types d’adresses IPv4 à invoquer une API HTTP. Utilisez dualstack pour autoriser les types d’adresses IPv4 et IPv6 à invoquer une API HTTP. Seules les API HTTP sont prises en charge.

Exemples x-amazon-apigateway-endpoint-configuration

L’exemple suivant associe les points de terminaison de VPC spécifiés à l’API REST.

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

L’exemple suivant désactive le point de terminaison par défaut d’une API.

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

L’exemple suivant définit le type d’adresse IP sur « double pile » pour une API HTTP.

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