update-hue¶

Description¶

Asynchronous operation that updates the configuration of a Hue Query Editor. The describe-hue can be used at any time to get the latest status of a Hue Query Editor.

Synopsis¶

  update-hue
--cluster-id <value>
--hue-id <value>
[--instance-count <value>]
[--user-groups <value>]
[--resource-pool <value>]
[--config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

ID of the Hue Query Editor’s cluster.

--hue-id (string)

ID of the Hue Query Editor.

--instance-count (integer)

Number of Hue Query Editor backend pods.

--user-groups (array)

User groups that are allowed to access to Hue Query Editor.

Syntax:

"string" "string" ...

--resource-pool (string)

The Resource Pool of the Hue Query Editor.

Form Factors: private

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

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.

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",
        "content": {
          "keyValues": {"string": "string"
            ...},
          "text": "string",
          "json": "string"
        }
      }
      ...
    ]
  },
  "applicationConfigs": {"string": {
        "configBlocks": [
          {
            "id": "string",
            "content": {
              "keyValues": {"string": "string"
                ...},
              "text": "string",
              "json": "string"
            }
          }
          ...
        ]
      }
    ...},
  "ldapGroups": ["string", ...],
  "enableSSO": true|false
}

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

status -> (string)

The status of asynchronous update configuration request for Hue Query Editor. To find the latest status please use describe-hue.

Form Factors¶

public, private