x-amazon-apigateway-endpoint-configuration オブジェクト

API のエンドポイント設定の詳細を指定します。この拡張は、OpenAPI Operation オブジェクトの拡張プロパティです。このオブジェクトは、Swagger 2.0 の最上位ベンダー拡張に存在する必要があります。OpenAPI 3.0 では、サーバーオブジェクトのベンダー拡張の下に存在する必要があります。

プロパティ名	タイプ	説明
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 でのみサポートされています。

x-amazon-apigateway-endpoint-configuration の例

次の例では、指定された VPC エンドポイントを REST API に関連付けます。

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

次の例では、API のデフォルトのエンドポイントを無効にします。

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