create-vw

subtitle

Create a Virtual Warehouse.

version

0.9.79

Description

Create a Virtual Warehouse.

Synopsis

  create-vw
--cluster-id <value>
--dbc-id <value>
--vw-type <value>
--name <value>
[--image-version <value>]
[--template <value>]
[--node-count <value>]
[--autoscaling <value>]
[--config <value>]
[--query-isolation-options <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--cluster-id (string)

ID of cluster where Virtual Warehouse should be created.

--dbc-id (string)

ID of Database Catalog that the Virtual Warehouse should be attached to.

--vw-type (string)

Type of Virtual Warehouse: ‘hive’ or ‘impala’.

Possible values:

  • hive

  • impala

--name (string)

Name of the Virtual Warehouse.

--image-version (string)

version of the Virtual Warehouse.

Form Factors: public

--template (string)

Name of configuration template to use.

Possible values:

  • xsmall

  • small

  • medium

  • large

--node-count (integer)

Node Count per compute cluster. Implies ‘custom’ template, even if you pass template explicitly.

--autoscaling (object)

Auto-scaling configuration for a Virtual Warehouse.

minClusters -> (integer)

Minimum number of available compute groups.

maxClusters -> (integer)

Maximum number of available compute groups.

disableAutoSuspend -> (boolean)

Turn off auto suspend for Virtual Warehouse.

autoSuspendTimeoutSeconds -> (integer)

Auto suspend threshold for Virtual Warehouse.

enableUnifiedAnalytics -> (boolean)

Enable Unified Analytics. In case of Hive Virtual Warehouses this cannot be provided, because this value is inferred. In case of Impala this can be set. Passing –query-isolation-options will be considered if this flag is set to true. If Unified Analytics enabled then the “impalaEnableShutdownOfCoordinator” explicitly disabled and should not be provided, furthermore the “impalaHighAvailabilityMode” cannot be set to ACTIVE_ACTIVE.

hiveScaleWaitTimeSeconds -> (integer)

Set wait time before a scale event happens. Either “hiveScaleWaitTimeSeconds” or “hiveDesiredFreeCapacity” can be provided.

hiveDesiredFreeCapacity -> (integer)

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

impalaHighAvailabilityMode -> (string)

Set High Availability mode. If not provided the default will apply. This value is disregarded for Hive.

impalaScaleUpDelaySeconds -> (integer)

Scale up the scaling up threshold in seconds. If not provided defaults will apply.

impalaScaleDownDelaySeconds -> (integer)

Scale down threshold in seconds. If not provided defaults will apply.

impalaEnableShutdownOfCoordinator -> (boolean)

Enables a shutdown of the coordinator. If Unified Analytics enabled then this setting explicitly disabled and should not be provided.

impalaShutdownOfCoordinatorDelaySeconds -> (integer)

Delay in seconds before the shutdown of coordinator event happens.

impalaNumOfActiveCoordinators -> (integer)

Number of the active coordinators.

impalaEnableCatalogHighAvailability -> (boolean)

Enables a backup instance for Impala catalog to ensure high availability.

podConfigName -> (string)

Name of the pod configuration.

Shorthand Syntax:

minClusters=integer,maxClusters=integer,disableAutoSuspend=boolean,autoSuspendTimeoutSeconds=integer,enableUnifiedAnalytics=boolean,hiveScaleWaitTimeSeconds=integer,hiveDesiredFreeCapacity=integer,impalaHighAvailabilityMode=string,impalaScaleUpDelaySeconds=integer,impalaScaleDownDelaySeconds=integer,impalaEnableShutdownOfCoordinator=boolean,impalaShutdownOfCoordinatorDelaySeconds=integer,impalaNumOfActiveCoordinators=integer,impalaEnableCatalogHighAvailability=boolean,podConfigName=string

JSON Syntax:

{
  "minClusters": integer,
  "maxClusters": integer,
  "disableAutoSuspend": true|false,
  "autoSuspendTimeoutSeconds": integer,
  "enableUnifiedAnalytics": true|false,
  "hiveScaleWaitTimeSeconds": integer,
  "hiveDesiredFreeCapacity": integer,
  "impalaHighAvailabilityMode": "ACTIVE_PASSIVE"|"ACTIVE_ACTIVE"|"DISABLED",
  "impalaScaleUpDelaySeconds": integer,
  "impalaScaleDownDelaySeconds": integer,
  "impalaEnableShutdownOfCoordinator": true|false,
  "impalaShutdownOfCoordinatorDelaySeconds": integer,
  "impalaNumOfActiveCoordinators": integer,
  "impalaEnableCatalogHighAvailability": true|false,
  "podConfigName": "string"
}

--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
}

--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
}

--tags (array)

Tags associated with the resources.

Shorthand Syntax:

key=string,value=string ... (separate items with spaces)

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--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

vwId -> (string)

ID of the new Virtual Warehouse.

Form Factors

public, private