update-resource-template¶

Description¶

This command’s purpose is to facilitate the update of resource templates in CDW. Users are allowed to tailor default CPU and Memory settings according to their needs. Setting up these values correctly is crucial when creating Hive / Impala and DataViz instances using the ‘create-vw’ / ‘create-data-visualisation’ commands. The ‘id’ of the response object must be supplied in the ‘create-vw’ / ‘create-data-visualisation’ command ‘template’ field to specify the chosen resource allocation size. Please note, that the ‘default’ fields in the response denote the default supplied value if the ‘template’ is not specified in the create commands. These templates are versioned so that users can rollback to a particular version. Existing resources are not affected by rollback. Learn more about each resource allocation with the ‘describe-resource’ command.

Synopsis¶

  update-resource-template
[--template-id <value>]
[--name <value>]
[--description <value>]
[--resources <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--template-id (string)

The ID of the template.

--name (string)

Name of the template.

--description (string)

Description of the template.

--resources (map)

The resource values of the template.

Shorthand Syntax:

KeyName1={cpu=float,memory=string,breakdown={xms=string,xmx=string,headroom=string,xss=string,maxDirectMemorySize=string,waitQueueSize=integer},ephemeralStorage=string,localStorageSize={scratch=string,cache=string,overhead=string}},KeyName2={cpu=float,memory=string,breakdown={xms=string,xmx=string,headroom=string,xss=string,maxDirectMemorySize=string,waitQueueSize=integer},ephemeralStorage=string,localStorageSize={scratch=string,cache=string,overhead=string}}

JSON Syntax:

{"string": {
      "cpu": float,
      "memory": "string",
      "breakdown": {
        "xms": "string",
        "xmx": "string",
        "headroom": "string",
        "xss": "string",
        "maxDirectMemorySize": "string",
        "waitQueueSize": integer
      },
      "ephemeralStorage": "string",
      "localStorageSize": {
        "scratch": "string",
        "cache": "string",
        "overhead": "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¶

templateId -> (string)

The id of the updated template.

Form Factors¶

private