# x-amazon-apigateway-endpoint-configuration オブジェクト
<a name="api-gateway-swagger-extensions-endpoint-configuration"></a>

API のエンドポイント設定の詳細を指定します。この拡張は、[OpenAPI Operation](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 アドレスタイプに HTTP API の呼び出しを許可するには、`ipv4` を使用します。IPv4 アドレスタイプと IPv6 アドレスタイプに HTTP API の呼び出しを許可するは、`dualstack` を使用します。これは 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"
}
```