x-amazon-apigateway-endpoint-objeto de configuração - Amazon API Gateway

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

x-amazon-apigateway-endpoint-objeto de configuração

Especifica detalhes da configuração do endpoint de uma API. Esta extensão é uma propriedade estendida do objeto de Operação do OpenAPI. Esse objeto deve estar presente em extensões de fornecedor de nível superior para o Swagger 2.0. Para a OpenAPI 3.0, ele deve estar presente nas extensões de fornecedor do objeto Server.

Propriedades
Nome da propriedade Tipo Descrição
disableExecuteApiEndpoint Booliano

Especifica se os clientes podem invocar sua API usando o endpoint execute-api padrão. Por padrão, os clientes podem invocar sua API com o endpoint https://{api_id}.execute-api.{region}.amazonaws.com padrão. Para exigir que os clientes usem um nome de domínio personalizado para invocar sua API, especifique true.

vpcEndpointIds Uma matriz de String

Uma lista de VpcEndpoint identificadores com os quais criar registros de alias do Route 53 para uma API REST. Ele só é compatível com APIs REST do tipo de endpoint PRIVATE.

x-amazon-apigateway-endpoint-exemplos de configuração

O exemplo a seguir associa VPC endpoints especificados à API REST.

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

O exemplo a seguir desabilita o endpoint padrão para uma API.

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