Oggetto x-amazon-apigateway-endpoint-configuration - Amazon API Gateway
Esempi di x-amazon-apigateway-endpoint-configuration

Oggetto x-amazon-apigateway-endpoint-configuration

Specifica i dettagli della configurazione dell'endpoint per un'API. Questa estensione è una proprietà estesa dell'oggetto OpenAPI Operation. Questo oggetto deve essere presente nelle estensioni dei fornitori di primo livello per Swagger 2.0. Per OpenAPI 3.0, deve essere presente nelle estensioni dei fornitori dell'oggetto Server.

Nome proprietà Tipo Descrizione
disableExecuteApiEndpoint Booleano

Specifica se i client possono richiamare l'API utilizzando l'endpoint execute-api predefinito. Per impostazione predefinita, i client possono richiamare l'API con l'endpoint https://{api_id}.execute-api.{region}.amazonaws.com predefinito. Per richiedere che i client utilizzino un nome di dominio personalizzato per richiamare l'API, specifica true.
vpcEndpointIds Una matrice di String

Un elenco di identificatori VpcEndpoint su cui creare record di alias Route 53 per un'API REST. È supportato solo per il tipo di endpoint PRIVATE di API REST.
ipAddressType string

I tipi di indirizzo IP che possono invocare un’API HTTP. Utilizzare ipv4 per consentire ai tipi di indirizzo IPv4 di invocare un’API HTTP. Utilizzare dualstack per consentire ai tipi di indirizzo IPv4 e IPv6 di invocare un’API HTTP. È supportata solo per le API HTTP.

Esempi di x-amazon-apigateway-endpoint-configuration

L'esempio seguente associa gli endpoint VPC specificati all'API REST.

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

Nell'esempio seguente l'endpoint predefinito per un'API viene disattivato.

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

Nell’esempio seguente si imposta il tipo di indirizzo IP su Dualstack per un’API HTTP.

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