UpdateVwRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cloudera/main/json-schema/cloudera-update-vw-request-schema.json",
  "title": "UpdateVwRequest",
  "description": "Request object for the updateVw method.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudera-dw-api-openapi.yml#/components/schemas/UpdateVwRequest",
  "type": "object",
  "required": [
    "clusterId",
    "vwId"
  ],
  "properties": {
    "clusterId": {
      "type": "string",
      "description": "ID of the Virtual Warehouse's cluster."
    },
    "vwId": {
      "type": "string",
      "description": "ID of the Virtual Warehouse."
    },
    "tShirtSize": {
      "type": "string",
      "description": "Name of T-shirt size to use, which will determine the number of nodes.",
      "enum": [
        "xsmall",
        "small",
        "medium",
        "large",
        "waa"
      ]
    },
    "nodeCount": {
      "type": "integer",
      "format": "int32",
      "default": 0,
      "description": "Nodes per compute cluster. If specified, forces 'template' to be 'custom'"
    },
    "config": {
      "description": "The service configuration to update the VW with. This will be applied on top of the existing configuration so there's no need to list configurations that stay the same.",
      "$ref": "#/$defs/ServiceConfigReq"
    },
    "autoscaling": {
      "description": "Autoscaling settings for the Virtual Warehouse.",
      "$ref": "#/$defs/AutoscalingOptionsUpdateRequest"
    },
    "impalaHaSettings": {
      "description": "High Availability settings update for the Impala Virtual Warehouse.",
      "$ref": "#/$defs/ImpalaHASettingsUpdateRequest"
    },
    "queryIsolationOptions": {
      "description": "Query isolation settings for Hive Virtual Warehouses.",
      "$ref": "#/$defs/QueryIsolationOptionsRequest"
    },
    "hiveAuthenticationMode": {
      "type": [
        "string",
        "null"
      ],
      "x-deprecated": true,
      "x-form-factors": "private",
      "description": "DEPRECATED - Sets the authentication mode to use by Hive Server: * `LDAP` * `KERBEROS` If not set then the authentication mode will not be changed during update."
    },
    "platformJwtAuth": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Value of 'true' automatically configures the Virtual Warehouse to support JWTs issues by the CDP JWT token provider.  Value of 'false' does not enable JWT auth on the Virtual Warehouse.  If this field is not specified, it defaults to 'false'."
    },
    "impalaQueryLog": {
      "type": [
        "boolean",
        "null"
      ],
      "x-form-factors": "public",
      "description": "Denotes whether the Virtual Warehouse has the Impala Query Log enabled or not."
    },
    "logHiveQueries": {
      "x-form-factors": "private",
      "type": [
        "boolean",
        "null"
      ],
      "description": "Denotes whether the Hive Virtual Warehouse stores Hive query information for all completed queries in the sys.query_history system table. You can query this table using SQL to monitor and optimize the Hive engine."
    },
    "hiveServerHaMode": {
      "type": [
        "string",
        "null"
      ],
      "x-form-factors": "private",
      "description": "If specified, modifies Hive Server High Availability mode in Private Cloud: * `DISABLED` - Disables Hive Server high availability. * `ACTIVE_PASSIVE` - Runs two Hive Server instances, one active and one passive. Hive session failover is not supported in this setup."
    },
    "associatedConnectors": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "$ref": "#/$defs/ConnectorData"
      },
      "description": "Map of connector ID to connector information for the VW."
    },
    "additionalQuota": {
      "x-form-factors": "private",
      "$ref": "#/$defs/QuotaRequest",
      "description": "Setting the quota for the 3rd party services injected into the Virtual Warehouse namespace."
    }
  },
  "$defs": {
    "ApplicationConfigReq": {
      "type": "object",
      "description": "Configurations for an application inside a service.",
      "properties": {
        "configBlocks": {
          "type": "array",
          "description": "List of ConfigBlocks for the application.",
          "items": {
            "$ref": "#/$defs/ConfigBlockReq"
          }
        }
      }
    },
    "AutoscalingOptionsUpdateRequest": {
      "type": "object",
      "description": "Auto-scaling configuration for a Virtual Warehouse. Provide those values only that you want to update.",
      "properties": {
        "minClusters": {
          "type": "integer",
          "format": "int32",
          "default": 0,
          "description": "Sets the minimum number of Executor Groups. Zero means the minClusters will not be updated."
        },
        "maxClusters": {
          "type": "integer",
          "format": "int32",
          "default": 0,
          "description": "Sets the maximum number of Executor Groups the Virtual Warehouse can scale up to. Zero means that this value will not be updated. This value defines the upper boundary for autoscaling. The total node capacity is determined by this number multiplied by the number of nodes in the selected `--t-shirt-size`. NOTE: On Azure, all IPs for the maximum node count are pre-allocated. If you use the same `--instance-type` for multiple Virtual Warehouses, they will share the same underlying nodepool and its limit is calculated as the sum of all nodes required by the corresponding Virtual Warehouses."
        },
        "disableAutoSuspend": {
          "type": "boolean",
          "description": "Turn off auto suspend for Virtual Warehouse."
        },
        "autoSuspendTimeoutSeconds": {
          "type": "integer",
          "format": "int32",
          "description": "Auto suspend threshold for Virtual Warehouse."
        },
        "hiveScaleWaitTimeSeconds": {
          "type": "integer",
          "format": "int32",
          "description": "Set wait time before a scale event happens. Either \"hiveScaleWaitTimeSeconds\" or \"hiveDesiredFreeCapacity\" can be provided. If \"hiveScaleWaitTimeSeconds\" provided, then the \"hiveDesiredFreeCapacity\" will be explicityly set to 0."
        },
        "hiveDesiredFreeCapacity": {
          "type": "integer",
          "format": "int32",
          "description": "Set Desired free capacity. Either \"hiveScaleWaitTimeSeconds\" or \"hiveDesiredFreeCapacity\" can be provided."
        },
        "impalaScaleUpDelaySeconds": {
          "type": "integer",
          "format": "int32",
          "description": "Scale up the scaling up threshold in seconds."
        },
        "impalaScaleDownDelaySeconds": {
          "type": "integer",
          "format": "int32",
          "description": "Scale down threshold in seconds."
        },
        "impalaShutdownOfCoordinatorDelaySeconds": {
          "x-deprecated": true,
          "type": "integer",
          "format": "int32",
          "description": "DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens."
        },
        "impalaNumOfActiveCoordinators": {
          "x-deprecated": true,
          "type": "integer",
          "format": "int32",
          "description": "DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators."
        },
        "impalaExecutorGroupSets": {
          "$ref": "#/$defs/ImpalaExecutorGroupSetsUpdateRequest",
          "description": "Re-configures executor group sets for workload aware autoscaling."
        }
      }
    },
    "ConfigBlockReq": {
      "type": "object",
      "description": "A piece of configuration stored in the same place (e.g. same file or environment variables).",
      "required": [
        "id",
        "content"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of the ConfigBlock. Unique within an ApplicationConfig."
        },
        "content": {
          "description": "Contents of a ConfigBlock.",
          "$ref": "#/$defs/ConfigContentReq"
        }
      }
    },
    "ConfigContentReq": {
      "type": "object",
      "description": "Contents of a ConfigBlock.",
      "properties": {
        "keyValues": {
          "type": "object",
          "description": "Key-value type configurations.",
          "additionalProperties": {
            "description": "Key-value type configurations.",
            "type": "string",
            "x-no-paramfile": true
          }
        },
        "text": {
          "type": "string",
          "description": "Text type configuration."
        },
        "json": {
          "type": "string",
          "description": "JSON type configuration."
        }
      }
    },
    "ConnectorData": {
      "type": [
        "object",
        "null"
      ],
      "description": "Information about a connector associated with a Virtual Warehouse.",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the connector",
          "x-omitempty": true
        },
        "configId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The config UUID of the connector",
          "x-omitempty": true
        }
      },
      "x-omitempty": true
    },
    "ImpalaExecutorGroupSetUpdateRequest": {
      "type": "object",
      "description": "Re-configure independently scaling set of uniformly sized executor groups.",
      "properties": {
        "execGroupSize": {
          "type": "integer",
          "format": "int32",
          "description": "Set number of executors per executor group."
        },
        "minExecutorGroups": {
          "type": "integer",
          "format": "int32",
          "description": "Set minimum number of executor groups allowed."
        },
        "maxExecutorGroups": {
          "type": "integer",
          "format": "int32",
          "description": "Set maximum number of executor groups allowed."
        },
        "autoSuspendTimeoutSeconds": {
          "type": "integer",
          "format": "int32",
          "description": "Set auto suspend threshold. If not provided defaults will apply."
        },
        "disableAutoSuspend": {
          "type": "boolean",
          "description": "Turn off auto suspend. If not provided defaults will apply."
        },
        "triggerScaleUpDelay": {
          "type": "integer",
          "format": "int32",
          "description": "Set scale up threshold in seconds. If not provided defaults will apply."
        },
        "triggerScaleDownDelay": {
          "type": "integer",
          "format": "int32",
          "description": "Set scale down threshold in seconds. If not provided defaults will apply."
        },
        "deleteGroupSet": {
          "type": "boolean",
          "description": "Delete the executor group set."
        }
      }
    },
    "ImpalaExecutorGroupSetsUpdateRequest": {
      "type": "object",
      "description": "Re-configure executor group sets for workload aware autoscaling.",
      "properties": {
        "small": {
          "$ref": "#/$defs/ImpalaExecutorGroupSetUpdateRequest",
          "description": "Re-configure small executor group set for workload aware autoscaling."
        },
        "custom1": {
          "$ref": "#/$defs/ImpalaExecutorGroupSetUpdateRequest",
          "description": "Re-configure first optional custom executor group set for workload aware autoscaling."
        },
        "custom2": {
          "$ref": "#/$defs/ImpalaExecutorGroupSetUpdateRequest",
          "description": "Re-configure second optional custom executor group set for workload aware autoscaling."
        },
        "custom3": {
          "$ref": "#/$defs/ImpalaExecutorGroupSetUpdateRequest",
          "description": "Re-configure third optional custom executor group set for workload aware autoscaling."
        },
        "large": {
          "$ref": "#/$defs/ImpalaExecutorGroupSetUpdateRequest",
          "description": "Re-configure large executor group set for workload aware autoscaling."
        }
      }
    },
    "ImpalaHASettingsUpdateRequest": {
      "type": "object",
      "description": "High Availability settings update options for the Impala Virtual Warehouse.",
      "properties": {
        "shutdownOfCoordinatorDelaySeconds": {
          "type": "integer",
          "format": "int32",
          "description": "Delay in seconds before the shutdown of coordinator event happens."
        },
        "numOfActiveCoordinators": {
          "type": "integer",
          "format": "int32",
          "description": "The number of active coordinators."
        },
        "impalaEnableGlobalAdmissionController": {
          "type": "boolean",
          "description": "Set whether the Impala Global Admission Controller is enabled. This feature can only be used with high-availability mode ACTIVE_ACTIVE."
        }
      }
    },
    "QueryIsolationOptionsRequest": {
      "type": "object",
      "description": "Configurations for Query Isolation.",
      "properties": {
        "maxQueries": {
          "type": "integer",
          "format": "int32",
          "default": 0,
          "description": "Maximum Concurrent Isolated Queries. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled."
        },
        "maxNodesPerQuery": {
          "type": "integer",
          "format": "int32",
          "default": 0,
          "description": "Maximum Nodes Per Isolated Query. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled."
        }
      }
    },
    "QuotaRequest": {
      "x-form-factors": "private",
      "type": "object",
      "description": "Quota in requests for the Virtual Warehouse.",
      "properties": {
        "cpu": {
          "type": "number",
          "format": "float",
          "description": "CPU quota in cores."
        },
        "memory": {
          "type": "integer",
          "format": "int32",
          "description": "Memory quota in MB."
        }
      }
    },
    "ServiceConfigReq": {
      "type": "object",
      "description": "Configurations for a service (DBC or VW)",
      "properties": {
        "commonConfigs": {
          "description": "Configurations that are applied to every application in the service.",
          "$ref": "#/$defs/ApplicationConfigReq"
        },
        "applicationConfigs": {
          "type": "object",
          "description": "Application specific configurations.",
          "additionalProperties": {
            "description": "Application specific configurations.",
            "$ref": "#/$defs/ApplicationConfigReq"
          }
        },
        "ldapGroups": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "LDAP Groupnames to be enabled for auth."
        },
        "enableSSO": {
          "type": "boolean",
          "description": "Should SSO be enabled for this VW."
        }
      }
    }
  }
}