describe-config¶

Description¶

Describe a service configuration.

Synopsis¶

  describe-config
--cluster-id <value>
--config-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

ID of the cluster.

--config-id (string)

ID of the service (Database Catalog or Virtual Warehouse).

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

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)

List of LDAP Groupnames to be enabled for auth.

item -> (string)

enableSSO -> (boolean)

Should SSO be enabled for this VW. This cannot be changed later.

Form Factors¶

public, private