`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

using HashiCorp.Cdktf.Providers.Hcp;

new WaypointTemplate(Construct Scope, string Id, WaypointTemplateConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`WaypointTemplateConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`Id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`Config`^Required

Type: WaypointTemplateConfig

Methods

Name	Description
`ToString`	Returns a string representation of this construct.
`AddOverride`	No description.
`OverrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`ResetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`ToHclTerraform`	No description.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`AddMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`HasResourceMove`	No description.
`ImportFrom`	No description.
`InterpolationForAttribute`	No description.
`MoveFromId`	Move the resource corresponding to "id" to this resource.
`MoveTo`	Moves this resource to the target resource given by moveTarget.
`MoveToId`	Moves this resource to the resource corresponding to "id".
`PutTerraformCloudWorkspaceDetails`	No description.
`PutVariableOptions`	No description.
`ResetDescription`	No description.
`ResetLabels`	No description.
`ResetProjectId`	No description.
`ResetReadmeMarkdownTemplate`	No description.
`ResetTerraformAgentPoolId`	No description.
`ResetTerraformCloudWorkspaceDetails`	No description.
`ResetTerraformExecutionMode`	No description.
`ResetUseModuleReadme`	No description.
`ResetVariableOptions`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

private void AddMoveTarget(string MoveTarget)

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

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

private void MoveFromId(string Id)

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.

`Id`^Required

Type: string

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

`MoveTo`

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

`MoveTarget`^Required

Type: string

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

`Index`^Optional

Type: object

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

`MoveToId`

private void MoveToId(string Id)

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

`Id`^Required

Type: string

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

`PutTerraformCloudWorkspaceDetails`

private void PutTerraformCloudWorkspaceDetails(WaypointTemplateTerraformCloudWorkspaceDetails Value)

`Value`^Required

Type: WaypointTemplateTerraformCloudWorkspaceDetails

`PutVariableOptions`

private void PutVariableOptions(object Value)

`Value`^Required

Type: object

`ResetDescription`

private void ResetDescription()

`ResetLabels`

private void ResetLabels()

`ResetProjectId`

private void ResetProjectId()

`ResetReadmeMarkdownTemplate`

private void ResetReadmeMarkdownTemplate()

`ResetTerraformAgentPoolId`

private void ResetTerraformAgentPoolId()

`ResetTerraformCloudWorkspaceDetails`

private void ResetTerraformCloudWorkspaceDetails()

`ResetTerraformExecutionMode`

private void ResetTerraformExecutionMode()

`ResetUseModuleReadme`

private void ResetUseModuleReadme()

`ResetVariableOptions`

private void ResetVariableOptions()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a WaypointTemplate resource upon running "cdktf plan ".

`IsConstruct`

using HashiCorp.Cdktf.Providers.Hcp;

WaypointTemplate.IsConstruct(object X);

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.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Hcp;

WaypointTemplate.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Hcp;

WaypointTemplate.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Hcp;

WaypointTemplate.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`ImportToId`^Required

Type: string

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

`ImportFromId`^Required

Type: string

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

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`HashiCorp.Cdktf.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Id`	`string`	No description.
`OrganizationId`	`string`	No description.
`TerraformCloudWorkspaceDetails`	`WaypointTemplateTerraformCloudWorkspaceDetailsOutputReference`	No description.
`VariableOptions`	`WaypointTemplateVariableOptionsList`	No description.
`DescriptionInput`	`string`	No description.
`LabelsInput`	`string[]`	No description.
`NameInput`	`string`	No description.
`ProjectIdInput`	`string`	No description.
`ReadmeMarkdownTemplateInput`	`string`	No description.
`SummaryInput`	`string`	No description.
`TerraformAgentPoolIdInput`	`string`	No description.
`TerraformCloudWorkspaceDetailsInput`	`object`	No description.
`TerraformExecutionModeInput`	`string`	No description.
`TerraformNoCodeModuleSourceInput`	`string`	No description.
`TerraformProjectIdInput`	`string`	No description.
`UseModuleReadmeInput`	`object`	No description.
`VariableOptionsInput`	`object`	No description.
`Description`	`string`	No description.
`Labels`	`string[]`	No description.
`Name`	`string`	No description.
`ProjectId`	`string`	No description.
`ReadmeMarkdownTemplate`	`string`	No description.
`Summary`	`string`	No description.
`TerraformAgentPoolId`	`string`	No description.
`TerraformExecutionMode`	`string`	No description.
`TerraformNoCodeModuleSource`	`string`	No description.
`TerraformProjectId`	`string`	No description.
`UseModuleReadme`	`object`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`Id`^Required

public string Id { get; }

Type: string

`OrganizationId`^Required

public string OrganizationId { get; }

Type: string

`TerraformCloudWorkspaceDetails`^Required

public WaypointTemplateTerraformCloudWorkspaceDetailsOutputReference TerraformCloudWorkspaceDetails { get; }

Type: WaypointTemplateTerraformCloudWorkspaceDetailsOutputReference

`VariableOptions`^Required

public WaypointTemplateVariableOptionsList VariableOptions { get; }

Type: WaypointTemplateVariableOptionsList

`DescriptionInput`^Optional

public string DescriptionInput { get; }

Type: string

`LabelsInput`^Optional

public string[] LabelsInput { get; }

Type: string[]

`NameInput`^Optional

public string NameInput { get; }

Type: string

`ProjectIdInput`^Optional

public string ProjectIdInput { get; }

Type: string

`ReadmeMarkdownTemplateInput`^Optional

public string ReadmeMarkdownTemplateInput { get; }

Type: string

`SummaryInput`^Optional

public string SummaryInput { get; }

Type: string

`TerraformAgentPoolIdInput`^Optional

public string TerraformAgentPoolIdInput { get; }

Type: string

`TerraformCloudWorkspaceDetailsInput`^Optional

public object TerraformCloudWorkspaceDetailsInput { get; }

Type: object

`TerraformExecutionModeInput`^Optional

public string TerraformExecutionModeInput { get; }

Type: string

`TerraformNoCodeModuleSourceInput`^Optional

public string TerraformNoCodeModuleSourceInput { get; }

Type: string

`TerraformProjectIdInput`^Optional

public string TerraformProjectIdInput { get; }

Type: string

`UseModuleReadmeInput`^Optional

public object UseModuleReadmeInput { get; }

Type: object

`VariableOptionsInput`^Optional

public object VariableOptionsInput { get; }

Type: object

`Description`^Required

public string Description { get; }

Type: string

`Labels`^Required

public string[] Labels { get; }

Type: string[]

`Name`^Required

public string Name { get; }

Type: string

`ProjectId`^Required

public string ProjectId { get; }

Type: string

`ReadmeMarkdownTemplate`^Required

public string ReadmeMarkdownTemplate { get; }

Type: string

`Summary`^Required

public string Summary { get; }

Type: string

`TerraformAgentPoolId`^Required

public string TerraformAgentPoolId { get; }

Type: string

`TerraformExecutionMode`^Required

public string TerraformExecutionMode { get; }

Type: string

`TerraformNoCodeModuleSource`^Required

public string TerraformNoCodeModuleSource { get; }

Type: string

`TerraformProjectId`^Required

public string TerraformProjectId { get; }

Type: string

`UseModuleReadme`^Required

public object UseModuleReadme { get; }

Type: object

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

WaypointTemplateConfig

Initializer

using HashiCorp.Cdktf.Providers.Hcp;

new WaypointTemplateConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string Summary,
    string TerraformNoCodeModuleSource,
    string TerraformProjectId,
    string Description = null,
    string[] Labels = null,
    string ProjectId = null,
    string ReadmeMarkdownTemplate = null,
    string TerraformAgentPoolId = null,
    WaypointTemplateTerraformCloudWorkspaceDetails TerraformCloudWorkspaceDetails = null,
    string TerraformExecutionMode = null,
    object UseModuleReadme = null,
    object VariableOptions = null
};

Properties

Name	Type	Description
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`HashiCorp.Cdktf.ITerraformDependable[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Name`	`string`	The name of the Template.
`Summary`	`string`	A brief description of the template, up to 110 characters.
`TerraformNoCodeModuleSource`	`string`	Terraform Cloud No-Code Module details.
`TerraformProjectId`	`string`	The ID of the Terraform Cloud Project to create workspaces in.
`Description`	`string`	A description of the template, along with when and why it should be used, up to 500 characters.
`Labels`	`string[]`	List of labels attached to this Template.
`ProjectId`	`string`	The ID of the HCP project where the Waypoint Template is located.
`ReadmeMarkdownTemplate`	`string`	Instructions for using the template (markdown format supported).
`TerraformAgentPoolId`	`string`	The ID of the agent pool to use for Terraform operations, for workspaces created for applications using this template.
`TerraformCloudWorkspaceDetails`	`WaypointTemplateTerraformCloudWorkspaceDetails`	Terraform Cloud Workspace details.
`TerraformExecutionMode`	`string`	The execution mode of the HCP Terraform workspaces created for applications using this template.
`UseModuleReadme`	`object`	If true, will auto-import the readme form the Terraform odule used.
`VariableOptions`	`object`	List of variable options for the template.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`Name`^Required

public string Name { get; set; }

Type: string

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}

`Summary`^Required

public string Summary { get; set; }

Type: string

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}

`TerraformNoCodeModuleSource`^Required

public string TerraformNoCodeModuleSource { get; set; }

Type: string

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}

`TerraformProjectId`^Required

public string TerraformProjectId { get; set; }

Type: string

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}

`Description`^Optional

public string Description { get; set; }

Type: string

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}

`Labels`^Optional

public string[] Labels { get; set; }

Type: string[]

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}

`ProjectId`^Optional

public string ProjectId { get; set; }

Type: string

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}

`ReadmeMarkdownTemplate`^Optional

public string ReadmeMarkdownTemplate { get; set; }

Type: string

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}

`TerraformAgentPoolId`^Optional

public string TerraformAgentPoolId { get; set; }

Type: string

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}

`TerraformCloudWorkspaceDetails`^Optional

public WaypointTemplateTerraformCloudWorkspaceDetails TerraformCloudWorkspaceDetails { get; set; }

Type: 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}

`TerraformExecutionMode`^Optional

public string TerraformExecutionMode { get; set; }

Type: string

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}

`UseModuleReadme`^Optional

public object UseModuleReadme { get; set; }

Type: object

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}

`VariableOptions`^Optional

public object VariableOptions { get; set; }

Type: object

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

using HashiCorp.Cdktf.Providers.Hcp;

new WaypointTemplateTerraformCloudWorkspaceDetails {
    string Name,
    string TerraformProjectId
};

Properties

Name	Type	Description
`Name`	`string`	Name of the Terraform Cloud Project.
`TerraformProjectId`	`string`	Terraform Cloud Project ID.

`Name`^Required

public string Name { get; set; }

Type: string

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}

`TerraformProjectId`^Required

public string TerraformProjectId { get; set; }

Type: string

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

using HashiCorp.Cdktf.Providers.Hcp;

new WaypointTemplateVariableOptions {
    string Name,
    string VariableType,
    string[] Options = null,
    object UserEditable = null
};

Properties

Name	Type	Description
`Name`	`string`	Variable name.
`VariableType`	`string`	Variable type.
`Options`	`string[]`	List of options.
`UserEditable`	`object`	Whether the variable is editable by the user creating an application.

`Name`^Required

public string Name { get; set; }

Type: string

Variable name.

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

`VariableType`^Required

public string VariableType { get; set; }

Type: string

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}

`Options`^Optional

public string[] Options { get; set; }

Type: string[]

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}

`UserEditable`^Optional

public object UserEditable { get; set; }

Type: object

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

using HashiCorp.Cdktf.Providers.Hcp;

new WaypointTemplateTerraformCloudWorkspaceDetailsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`ComputeFqn`	No description.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`NameInput`	`string`	No description.
`TerraformProjectIdInput`	`string`	No description.
`Name`	`string`	No description.
`TerraformProjectId`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

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.

`Fqn`^Required

public string Fqn { get; }

Type: string

`NameInput`^Optional

public string NameInput { get; }

Type: string

`TerraformProjectIdInput`^Optional

public string TerraformProjectIdInput { get; }

Type: string

`Name`^Required

public string Name { get; }

Type: string

`TerraformProjectId`^Required

public string TerraformProjectId { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

WaypointTemplateVariableOptionsList

Initializers

using HashiCorp.Cdktf.Providers.Hcp;

new WaypointTemplateVariableOptionsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`WrapsSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`WrapsSet`^Required

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
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

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

`MapKeyAttributeName`^Required

Type: string

`ComputeFqn`

private string ComputeFqn()

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

private WaypointTemplateVariableOptionsOutputReference Get(double Index)

`Index`^Required

Type: double

the index of the item to return.

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

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.

`Fqn`^Required

public string Fqn { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

WaypointTemplateVariableOptionsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Hcp;

new WaypointTemplateVariableOptionsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`ComplexObjectIndex`	`double`	the index of this item in the list.
`ComplexObjectIsFromSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`ComplexObjectIndex`^Required

Type: double

the index of this item in the list.

`ComplexObjectIsFromSet`^Required

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
`ComputeFqn`	No description.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetOptions`	No description.
`ResetUserEditable`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetOptions`

private void ResetOptions()

`ResetUserEditable`

private void ResetUserEditable()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`NameInput`	`string`	No description.
`OptionsInput`	`string[]`	No description.
`UserEditableInput`	`object`	No description.
`VariableTypeInput`	`string`	No description.
`Name`	`string`	No description.
`Options`	`string[]`	No description.
`UserEditable`	`object`	No description.
`VariableType`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

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.

`Fqn`^Required

public string Fqn { get; }

Type: string

`NameInput`^Optional

public string NameInput { get; }

Type: string

`OptionsInput`^Optional

public string[] OptionsInput { get; }

Type: string[]

`UserEditableInput`^Optional

public object UserEditableInput { get; }

Type: object

`VariableTypeInput`^Optional

public string VariableTypeInput { get; }

Type: string

`Name`^Required

public string Name { get; }

Type: string

`Options`^Required

public string[] Options { get; }

Type: string[]

`UserEditable`^Required

public object UserEditable { get; }

Type: object

`VariableType`^Required

public string VariableType { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

Files

waypointTemplate.csharp.md

Latest commit

History

waypointTemplate.csharp.md

File metadata and controls

waypointTemplate Submodule

Constructs