hcp waypoint add-ons definitions update reference

Command: hcp waypoint add-ons definitions update

The hcp waypoint add-ons definitions update command lets you update an existing HCP Waypoint add-on definition.

Usage

$ hcp waypoint add-ons definitions update --name=NAME [Optional Flags]

Examples

Update a HCP Waypoint add-on definition:

$ hcp waypoint add-ons definitions update -n=my-add-on-definition \
  -s="My updated Add-on Definition summary." \
  -d="My updated Add-on Definition description." \
  --readme-markdown-template-file "README.tpl" \
  --tfc-project-name="my-tfc-project" \
  --tfc-project-id="prj-123456" \
  -l=label1 \
  -l=label2

Required flags

• -n, --name=NAME - The name of the add-on definition.

Optional flags

• -d, --description=DESCRIPTION - The description of the add-on definition.

• -l, --label=LABEL [Repeatable] - A label to apply to the add-on definition.

• --readme-markdown-template-file=README_MARKDOWN_TEMPLATE_FILE - The README markdown template file.

• -s, --summary=SUMMARY - The summary of the add-on definition.

• --tf-agent-pool-id=TF_AGENT_POOL_ID - The ID of the Terraform agent pool to use for running Terraform operations. This is only applicable when the execution mode is set to 'agent'.

• --tf-execution-mode=TF_EXECUTION_MODE - The execution mode of the HCP Terraform workspaces for add-ons using this add-on definition.

• --tfc-project-id=TFC_PROJECT_ID - The Terraform Cloud project ID.

• --tfc-project-name=TFC_PROJECT_NAME - The Terraform Cloud project name.

• --variable-options-file=VARIABLE_OPTIONS_FILE - The file containing the HCL definition of Variable Options.