hcp waypoint add-ons definitions create reference

Command: hcp waypoint add-ons definitions create

The hcp waypoint add-ons definitions create command lets you create HCP Waypoint add-on definitions.

Usage

$ hcp waypoint add-ons definitions create  --tfc-no-code-module-source=TFC_NO_CODE_MODULE_SOURCE  --tfc-project-id=TFC_PROJECT_ID --tfc-project-name=TFC_PROJECT_NAME [Optional  Flags]

Examples

Create a new HCP Waypoint add-on definition:

$ hcp waypoint add-ons definitions create -n=my-add-on-definition \  -s="My Add-on Definition summary." \  -d="My Add-on Definition description." \  --readme-markdown-template-file="README.tpl" \  --tfc-no-code-module-source="app.terraform.io/hashicorp/dir/template" \  --tfc-project-name="my-tfc-project" \  --tfc-project-id="prj-123456" \  -l=label1 \  -l=label2

Required flags

• --tfc-no-code-module-source=TFC_NO_CODE_MODULE_SOURCE - The source of the Terraform no-code module. The expected format is "NAMESPACE/NAME/PROVIDER". An optional "HOSTNAME/" can be added at the beginning for a private registry.

• --tfc-project-id=TFC_PROJECT_ID - The ID of the Terraform Cloud project where applications using this add-on definition will be created.

• --tfc-project-name=TFC_PROJECT_NAME - The name of the Terraform Cloud project where applications using this add-on definition will be created.

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.

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

• --readme-markdown-template-file=README_MARKDOWN_TEMPLATE_FILE_PATH - The file containing the README markdown template.

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

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