update-vw¶

Description¶

Update the configuration of a Virtual Warehouse.

Synopsis¶

  update-vw
--cluster-id <value>
--vw-id <value>
[--config <value>]
[--autoscaling <value>]
[--query-isolation-options <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

ID of the Virtual Warehouse’s cluster.

--vw-id (string)

ID of the Virtual Warehouse.

--config (object)

Configurations for a service (DBC or VW)

commonConfigs -> (object)

Configurations for an application inside a service.

configBlocks -> (array)

List of ConfigBlocks for the application.

item -> (object)

A piece of configuration stored in the same place (e.g. same file or environment variables).

id -> (string)

ID of the ConfigBlock. Unique within an ApplicationConfig.

format -> (string)

Format of ConfigBlock.

content -> (object)

Contents of a ConfigBlock.

keyValues -> (map)

Key-value type configurations.

key -> (string)

value -> (string)

Key-value type configurations.

text -> (string)

Text type configuration.

json -> (string)

JSON type configuration.

applicationConfigs -> (map)

Application specific configurations.

key -> (string)

value -> (object)

Configurations for an application inside a service.

configBlocks -> (array)

List of ConfigBlocks for the application.

item -> (object)

A piece of configuration stored in the same place (e.g. same file or environment variables).

id -> (string)

ID of the ConfigBlock. Unique within an ApplicationConfig.

format -> (string)

Format of ConfigBlock.

content -> (object)

Contents of a ConfigBlock.

keyValues -> (map)

Key-value type configurations.

key -> (string)

value -> (string)

Key-value type configurations.

text -> (string)

Text type configuration.

json -> (string)

JSON type configuration.

ldapGroups -> (array)

LDAP Groupnames to be enabled for auth.

item -> (string)

enableSSO -> (boolean)

Should SSO be enabled for this VW.

JSON Syntax:

{
  "commonConfigs": {
    "configBlocks": [
      {
        "id": "string",
        "format": "HADOOP_XML"|"PROPERTIES"|"TEXT"|"JSON"|"BINARY"|"ENV"|"FLAGFILE",
        "content": {
          "keyValues": {"string": "string"
            ...},
          "text": "string",
          "json": "string"
        }
      }
      ...
    ]
  },
  "applicationConfigs": {"string": {
        "configBlocks": [
          {
            "id": "string",
            "format": "HADOOP_XML"|"PROPERTIES"|"TEXT"|"JSON"|"BINARY"|"ENV"|"FLAGFILE",
            "content": {
              "keyValues": {"string": "string"
                ...},
              "text": "string",
              "json": "string"
            }
          }
          ...
        ]
      }
    ...},
  "ldapGroups": ["string", ...],
  "enableSSO": true|false
}

--autoscaling (object)

Auto-scaling configuration for a Virtual Warehouse. Provide those values only that you want to update.

minClusters -> (integer)

Minimum number of available compute groups. Zero means, the minClusters will not be updated.

maxClusters -> (integer)

Maximum number of available compute groups. Zero means, the maxClusters will not be updated..

disableAutoSuspend -> (boolean)

Turn off auto suspend for Virtual Warehouse.

autoSuspendTimeoutSeconds -> (integer)

Auto suspend threshold for Virtual Warehouse.

hiveScaleWaitTimeSeconds -> (integer)

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 -> (integer)

Set Desired free capacity. Either “hiveScaleWaitTimeSeconds” or “hiveDesiredFreeCapacity” can be provided.

impalaScaleUpDelaySeconds -> (integer)

Scale up the scaling up threshold in seconds.

impalaScaleDownDelaySeconds -> (integer)

Scale down threshold in seconds.

impalaShutdownOfCoordinatorDelaySeconds -> (integer)

Delay in seconds before the shutdown of coordinator event happens.

impalaNumOfActiveCoordinators -> (integer)

Number of the active coordinators.

Shorthand Syntax:

minClusters=integer,maxClusters=integer,disableAutoSuspend=boolean,autoSuspendTimeoutSeconds=integer,hiveScaleWaitTimeSeconds=integer,hiveDesiredFreeCapacity=integer,impalaScaleUpDelaySeconds=integer,impalaScaleDownDelaySeconds=integer,impalaShutdownOfCoordinatorDelaySeconds=integer,impalaNumOfActiveCoordinators=integer

JSON Syntax:

{
  "minClusters": integer,
  "maxClusters": integer,
  "disableAutoSuspend": true|false,
  "autoSuspendTimeoutSeconds": integer,
  "hiveScaleWaitTimeSeconds": integer,
  "hiveDesiredFreeCapacity": integer,
  "impalaScaleUpDelaySeconds": integer,
  "impalaScaleDownDelaySeconds": integer,
  "impalaShutdownOfCoordinatorDelaySeconds": integer,
  "impalaNumOfActiveCoordinators": integer
}

--query-isolation-options (object)

Configurations for Query Isolation.

maxQueries -> (integer)

Maximum Concurrent Isolated Queries. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled.

maxNodesPerQuery -> (integer)

Maximum Nodes Per Isolated Query. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled.

Shorthand Syntax:

maxQueries=integer,maxNodesPerQuery=integer

JSON Syntax:

{
  "maxQueries": integer,
  "maxNodesPerQuery": integer
}

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

Form Factors¶

public, private