

# Objeto x-amazon-apigateway-endpoint-configuration
<a name="api-gateway-swagger-extensions-endpoint-configuration"></a>

Especifica detalhes da configuração do endpoint de uma API. Esta extensão é uma propriedade estendida do objeto de [Operação do OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object). Esse objeto deve estar presente em [extensões de fornecedor de nível superior](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#specification-extensions) para o Swagger 2.0. Para a OpenAPI 3.0, ele deve estar presente nas extensões de fornecedor do [objeto Server](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#server-object).


| 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 identificadores de VpcEndpoint nos quais criar aliases do Route 53 para uma API REST. Ele só é compatível com APIs REST do tipo de endpoint `PRIVATE`. | 
| ipAddressType | string | Os tipos de endereço IP que podem invocar uma API HTTP. Use `ipv4` para permitir que tipos de endereço IPv4 invoquem uma API HTTP. Use `dualstack` para permitir que tipos de endereço IPv4 e IPv6 invoquem uma API HTTP. É compatível apenas com APIs HTTP. | 

## Exemplos de x-amazon-apigateway-endpoint-configuration
<a name="api-gateway-swagger-extensions-endpoint-configuration-example"></a>

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
}
```

O exemplo a seguir define o tipo de endereço IP como pilha dupla para uma API HTTP.

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