

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

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

指定 API 的端點組態詳細資訊。此延伸是 [OpenAPI 操作](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object)物件的延伸屬性。這個物件應該位於 Swagger 2.0 的[上層廠商延伸](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#specification-extensions)中。對於 OpenAPI 3.0，它應該位於[伺服器物件](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#server-object)的廠商延伸下方。


| 屬性名稱 | 類型 | 描述 | 
| --- | --- | --- | 
| disableExecuteApiEndpoint | 布林值 |  指定用戶端是否可以使用預設 `execute-api` 端點叫用您的 API。根據預設，用戶端可以使用預設 `https://{api_id}.execute-api.{region}.amazonaws.com` 端點叫用您的 API。如要要求用戶端使用自訂網域名稱來叫用 API，請指定 `true`。  | 
| vpcEndpointIds | String 陣列 |  要為其建立 REST API 之 Route 53 別名記錄的 VpcEndpoint 識別符清單。僅支援 `PRIVATE` 端點類型的 REST API。  | 
| ipAddressType | string |  可調用 HTTP API 的 IP 位址類型。使用 `ipv4` 可允許 IPv4 位址類型調用 HTTP API。使用 `dualstack` 可允許 IPv4 和 IPv6 位址類型調用 HTTP API。僅 HTTP API 可支援。 | 

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

以下範例會將指定的 VPC 端點與 REST API 建立關聯。

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

下列範例會停用 API 的預設端點。

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

下列範例會將 HTTP API 的 IP 位址類型設定為雙堆疊。

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