Skip to content

Latest commit

 

History

History
2677 lines (1696 loc) · 116 KB

waypointTemplate.python.md

File metadata and controls

2677 lines (1696 loc) · 116 KB
Raw

waypointTemplate Submodule

Constructs

WaypointTemplate

Represents a {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template hcp_waypoint_template}.

Initializers 

from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplate(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  summary: str,
  terraform_no_code_module_source: str,
  terraform_project_id: str,
  description: str = None,
  labels: typing.List[str] = None,
  project_id: str = None,
  readme_markdown_template: str = None,
  terraform_agent_pool_id: str = None,
  terraform_cloud_workspace_details: WaypointTemplateTerraformCloudWorkspaceDetails = None,
  terraform_execution_mode: str = None,
  use_module_readme: typing.Union[bool, IResolvable] = None,
  variable_options: typing.Union[IResolvable, typing.List[WaypointTemplateVariableOptions]] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str The name of the Template.
summary str A brief description of the template, up to 110 characters.
terraform_no_code_module_source str Terraform Cloud No-Code Module details.
terraform_project_id str The ID of the Terraform Cloud Project to create workspaces in.
description str A description of the template, along with when and why it should be used, up to 500 characters.
labels typing.List[str] List of labels attached to this Template.
project_id str The ID of the HCP project where the Waypoint Template is located.
readme_markdown_template str Instructions for using the template (markdown format supported).
terraform_agent_pool_id str The ID of the agent pool to use for Terraform operations, for workspaces created for applications using this template.
terraform_cloud_workspace_details WaypointTemplateTerraformCloudWorkspaceDetails Terraform Cloud Workspace details.
terraform_execution_mode str The execution mode of the HCP Terraform workspaces created for applications using this template.
use_module_readme typing.Union[bool, cdktf.IResolvable] If true, will auto-import the readme form the Terraform odule used.
variable_options typing.Union[cdktf.IResolvable, typing.List[WaypointTemplateVariableOptions]] List of variable options for the template.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
nameRequired
  • Type: str

The name of the Template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#name WaypointTemplate#name}

summaryRequired
  • Type: str

A brief description of the template, up to 110 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#summary WaypointTemplate#summary}

terraform_no_code_module_sourceRequired
  • Type: str

Terraform Cloud No-Code Module details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_no_code_module_source WaypointTemplate#terraform_no_code_module_source}

terraform_project_idRequired
  • Type: str

The ID of the Terraform Cloud Project to create workspaces in.

The ID is found on the Terraform Cloud Project settings page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_project_id WaypointTemplate#terraform_project_id}

descriptionOptional
  • Type: str

A description of the template, along with when and why it should be used, up to 500 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#description WaypointTemplate#description}

labelsOptional
  • Type: typing.List[str]

List of labels attached to this Template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#labels WaypointTemplate#labels}

project_idOptional
  • Type: str

The ID of the HCP project where the Waypoint Template is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#project_id WaypointTemplate#project_id}

readme_markdown_templateOptional
  • Type: str

Instructions for using the template (markdown format supported).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#readme_markdown_template WaypointTemplate#readme_markdown_template}

terraform_agent_pool_idOptional
  • Type: str

The ID of the agent pool to use for Terraform operations, for workspaces created for applications using this template.

Required if terraform_execution_mode is set to 'agent'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_agent_pool_id WaypointTemplate#terraform_agent_pool_id}

terraform_cloud_workspace_detailsOptional

Terraform Cloud Workspace details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_cloud_workspace_details WaypointTemplate#terraform_cloud_workspace_details}

terraform_execution_modeOptional
  • Type: str

The execution mode of the HCP Terraform workspaces created for applications using this template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_execution_mode WaypointTemplate#terraform_execution_mode}

use_module_readmeOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

If true, will auto-import the readme form the Terraform odule used.

If this is set to true, users should not also set readme_markdown_template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#use_module_readme WaypointTemplate#use_module_readme}

variable_optionsOptional

List of variable options for the template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#variable_options WaypointTemplate#variable_options}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_terraform_cloud_workspace_details No description.
put_variable_options No description.
reset_description No description.
reset_labels No description.
reset_project_id No description.
reset_readme_markdown_template No description.
reset_terraform_agent_pool_id No description.
reset_terraform_cloud_workspace_details No description.
reset_terraform_execution_mode No description.
reset_use_module_readme No description.
reset_variable_options No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_terraform_cloud_workspace_details 
def put_terraform_cloud_workspace_details(
  name: str,
  terraform_project_id: str
) -> None
nameRequired
  • Type: str

Name of the Terraform Cloud Project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#name WaypointTemplate#name}

terraform_project_idRequired
  • Type: str

Terraform Cloud Project ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_project_id WaypointTemplate#terraform_project_id}

put_variable_options 
def put_variable_options(
  value: typing.Union[IResolvable, typing.List[WaypointTemplateVariableOptions]]
) -> None
valueRequired
reset_description 
def reset_description() -> None
reset_labels 
def reset_labels() -> None
reset_project_id 
def reset_project_id() -> None
reset_readme_markdown_template 
def reset_readme_markdown_template() -> None
reset_terraform_agent_pool_id 
def reset_terraform_agent_pool_id() -> None
reset_terraform_cloud_workspace_details 
def reset_terraform_cloud_workspace_details() -> None
reset_terraform_execution_mode 
def reset_terraform_execution_mode() -> None
reset_use_module_readme 
def reset_use_module_readme() -> None
reset_variable_options 
def reset_variable_options() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a WaypointTemplate resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplate.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplate.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplate.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplate.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a WaypointTemplate resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the WaypointTemplate to import.

import_from_idRequired
  • Type: str

The id of the existing WaypointTemplate that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the WaypointTemplate to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
id str No description.
organization_id str No description.
terraform_cloud_workspace_details WaypointTemplateTerraformCloudWorkspaceDetailsOutputReference No description.
variable_options WaypointTemplateVariableOptionsList No description.
description_input str No description.
labels_input typing.List[str] No description.
name_input str No description.
project_id_input str No description.
readme_markdown_template_input str No description.
summary_input str No description.
terraform_agent_pool_id_input str No description.
terraform_cloud_workspace_details_input typing.Union[cdktf.IResolvable, WaypointTemplateTerraformCloudWorkspaceDetails] No description.
terraform_execution_mode_input str No description.
terraform_no_code_module_source_input str No description.
terraform_project_id_input str No description.
use_module_readme_input typing.Union[bool, cdktf.IResolvable] No description.
variable_options_input typing.Union[cdktf.IResolvable, typing.List[WaypointTemplateVariableOptions]] No description.
description str No description.
labels typing.List[str] No description.
name str No description.
project_id str No description.
readme_markdown_template str No description.
summary str No description.
terraform_agent_pool_id str No description.
terraform_execution_mode str No description.
terraform_no_code_module_source str No description.
terraform_project_id str No description.
use_module_readme typing.Union[bool, cdktf.IResolvable] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
idRequired 
id: str
  • Type: str
organization_idRequired 
organization_id: str
  • Type: str
terraform_cloud_workspace_detailsRequired 
terraform_cloud_workspace_details: WaypointTemplateTerraformCloudWorkspaceDetailsOutputReference
variable_optionsRequired 
variable_options: WaypointTemplateVariableOptionsList
description_inputOptional 
description_input: str
  • Type: str
labels_inputOptional 
labels_input: typing.List[str]
  • Type: typing.List[str]
name_inputOptional 
name_input: str
  • Type: str
project_id_inputOptional 
project_id_input: str
  • Type: str
readme_markdown_template_inputOptional 
readme_markdown_template_input: str
  • Type: str
summary_inputOptional 
summary_input: str
  • Type: str
terraform_agent_pool_id_inputOptional 
terraform_agent_pool_id_input: str
  • Type: str
terraform_cloud_workspace_details_inputOptional 
terraform_cloud_workspace_details_input: typing.Union[IResolvable, WaypointTemplateTerraformCloudWorkspaceDetails]
terraform_execution_mode_inputOptional 
terraform_execution_mode_input: str
  • Type: str
terraform_no_code_module_source_inputOptional 
terraform_no_code_module_source_input: str
  • Type: str
terraform_project_id_inputOptional 
terraform_project_id_input: str
  • Type: str
use_module_readme_inputOptional 
use_module_readme_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
variable_options_inputOptional 
variable_options_input: typing.Union[IResolvable, typing.List[WaypointTemplateVariableOptions]]
descriptionRequired 
description: str
  • Type: str
labelsRequired 
labels: typing.List[str]
  • Type: typing.List[str]
nameRequired 
name: str
  • Type: str
project_idRequired 
project_id: str
  • Type: str
readme_markdown_templateRequired 
readme_markdown_template: str
  • Type: str
summaryRequired 
summary: str
  • Type: str
terraform_agent_pool_idRequired 
terraform_agent_pool_id: str
  • Type: str
terraform_execution_modeRequired 
terraform_execution_mode: str
  • Type: str
terraform_no_code_module_sourceRequired 
terraform_no_code_module_source: str
  • Type: str
terraform_project_idRequired 
terraform_project_id: str
  • Type: str
use_module_readmeRequired 
use_module_readme: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

WaypointTemplateConfig

Initializer 

from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplateConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  summary: str,
  terraform_no_code_module_source: str,
  terraform_project_id: str,
  description: str = None,
  labels: typing.List[str] = None,
  project_id: str = None,
  readme_markdown_template: str = None,
  terraform_agent_pool_id: str = None,
  terraform_cloud_workspace_details: WaypointTemplateTerraformCloudWorkspaceDetails = None,
  terraform_execution_mode: str = None,
  use_module_readme: typing.Union[bool, IResolvable] = None,
  variable_options: typing.Union[IResolvable, typing.List[WaypointTemplateVariableOptions]] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str The name of the Template.
summary str A brief description of the template, up to 110 characters.
terraform_no_code_module_source str Terraform Cloud No-Code Module details.
terraform_project_id str The ID of the Terraform Cloud Project to create workspaces in.
description str A description of the template, along with when and why it should be used, up to 500 characters.
labels typing.List[str] List of labels attached to this Template.
project_id str The ID of the HCP project where the Waypoint Template is located.
readme_markdown_template str Instructions for using the template (markdown format supported).
terraform_agent_pool_id str The ID of the agent pool to use for Terraform operations, for workspaces created for applications using this template.
terraform_cloud_workspace_details WaypointTemplateTerraformCloudWorkspaceDetails Terraform Cloud Workspace details.
terraform_execution_mode str The execution mode of the HCP Terraform workspaces created for applications using this template.
use_module_readme typing.Union[bool, cdktf.IResolvable] If true, will auto-import the readme form the Terraform odule used.
variable_options typing.Union[cdktf.IResolvable, typing.List[WaypointTemplateVariableOptions]] List of variable options for the template.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
nameRequired 
name: str
  • Type: str

The name of the Template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#name WaypointTemplate#name}

summaryRequired 
summary: str
  • Type: str

A brief description of the template, up to 110 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#summary WaypointTemplate#summary}

terraform_no_code_module_sourceRequired 
terraform_no_code_module_source: str
  • Type: str

Terraform Cloud No-Code Module details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_no_code_module_source WaypointTemplate#terraform_no_code_module_source}

terraform_project_idRequired 
terraform_project_id: str
  • Type: str

The ID of the Terraform Cloud Project to create workspaces in.

The ID is found on the Terraform Cloud Project settings page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_project_id WaypointTemplate#terraform_project_id}

descriptionOptional 
description: str
  • Type: str

A description of the template, along with when and why it should be used, up to 500 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#description WaypointTemplate#description}

labelsOptional 
labels: typing.List[str]
  • Type: typing.List[str]

List of labels attached to this Template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#labels WaypointTemplate#labels}

project_idOptional 
project_id: str
  • Type: str

The ID of the HCP project where the Waypoint Template is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#project_id WaypointTemplate#project_id}

readme_markdown_templateOptional 
readme_markdown_template: str
  • Type: str

Instructions for using the template (markdown format supported).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#readme_markdown_template WaypointTemplate#readme_markdown_template}

terraform_agent_pool_idOptional 
terraform_agent_pool_id: str
  • Type: str

The ID of the agent pool to use for Terraform operations, for workspaces created for applications using this template.

Required if terraform_execution_mode is set to 'agent'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_agent_pool_id WaypointTemplate#terraform_agent_pool_id}

terraform_cloud_workspace_detailsOptional 
terraform_cloud_workspace_details: WaypointTemplateTerraformCloudWorkspaceDetails

Terraform Cloud Workspace details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_cloud_workspace_details WaypointTemplate#terraform_cloud_workspace_details}

terraform_execution_modeOptional 
terraform_execution_mode: str
  • Type: str

The execution mode of the HCP Terraform workspaces created for applications using this template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_execution_mode WaypointTemplate#terraform_execution_mode}

use_module_readmeOptional 
use_module_readme: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

If true, will auto-import the readme form the Terraform odule used.

If this is set to true, users should not also set readme_markdown_template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#use_module_readme WaypointTemplate#use_module_readme}

variable_optionsOptional 
variable_options: typing.Union[IResolvable, typing.List[WaypointTemplateVariableOptions]]

List of variable options for the template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#variable_options WaypointTemplate#variable_options}

WaypointTemplateTerraformCloudWorkspaceDetails

Initializer 

from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplateTerraformCloudWorkspaceDetails(
  name: str,
  terraform_project_id: str
)

Properties

Name Type Description
name str Name of the Terraform Cloud Project.
terraform_project_id str Terraform Cloud Project ID.
nameRequired 
name: str
  • Type: str

Name of the Terraform Cloud Project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#name WaypointTemplate#name}

terraform_project_idRequired 
terraform_project_id: str
  • Type: str

Terraform Cloud Project ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#terraform_project_id WaypointTemplate#terraform_project_id}

WaypointTemplateVariableOptions

Initializer 

from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplateVariableOptions(
  name: str,
  variable_type: str,
  options: typing.List[str] = None,
  user_editable: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
name str Variable name.
variable_type str Variable type.
options typing.List[str] List of options.
user_editable typing.Union[bool, cdktf.IResolvable] Whether the variable is editable by the user creating an application.
nameRequired 
name: str
  • Type: str

Variable name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#name WaypointTemplate#name}

variable_typeRequired 
variable_type: str
  • Type: str

Variable type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#variable_type WaypointTemplate#variable_type}

optionsOptional 
options: typing.List[str]
  • Type: typing.List[str]

List of options.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#options WaypointTemplate#options}

user_editableOptional 
user_editable: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the variable is editable by the user creating an application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/waypoint_template#user_editable WaypointTemplate#user_editable}

Classes

WaypointTemplateTerraformCloudWorkspaceDetailsOutputReference

Initializers 

from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplateTerraformCloudWorkspaceDetailsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
name_input str No description.
terraform_project_id_input str No description.
name str No description.
terraform_project_id str No description.
internal_value typing.Union[cdktf.IResolvable, WaypointTemplateTerraformCloudWorkspaceDetails] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
terraform_project_id_inputOptional 
terraform_project_id_input: str
  • Type: str
nameRequired 
name: str
  • Type: str
terraform_project_idRequired 
terraform_project_id: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, WaypointTemplateTerraformCloudWorkspaceDetails]

WaypointTemplateVariableOptionsList

Initializers 

from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplateVariableOptionsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> WaypointTemplateVariableOptionsOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[WaypointTemplateVariableOptions]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[WaypointTemplateVariableOptions]]

WaypointTemplateVariableOptionsOutputReference

Initializers 

from cdktf_cdktf_provider_hcp import waypoint_template

waypointTemplate.WaypointTemplateVariableOptionsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_options No description.
reset_user_editable No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_options 
def reset_options() -> None
reset_user_editable 
def reset_user_editable() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
name_input str No description.
options_input typing.List[str] No description.
user_editable_input typing.Union[bool, cdktf.IResolvable] No description.
variable_type_input str No description.
name str No description.
options typing.List[str] No description.
user_editable typing.Union[bool, cdktf.IResolvable] No description.
variable_type str No description.
internal_value typing.Union[cdktf.IResolvable, WaypointTemplateVariableOptions] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
options_inputOptional 
options_input: typing.List[str]
  • Type: typing.List[str]
user_editable_inputOptional 
user_editable_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
variable_type_inputOptional 
variable_type_input: str
  • Type: str
nameRequired 
name: str
  • Type: str
optionsRequired 
options: typing.List[str]
  • Type: typing.List[str]
user_editableRequired 
user_editable: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
variable_typeRequired 
variable_type: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, WaypointTemplateVariableOptions]