Skip to content

Latest commit

 

History

History
3053 lines (1942 loc) · 142 KB

workspace.java.md

File metadata and controls

3053 lines (1942 loc) · 142 KB

workspace Submodule

Constructs

Workspace

Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace tfe_workspace}.

Initializers

import com.hashicorp.cdktf.providers.tfe.workspace.Workspace;

Workspace.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .agentPoolId(java.lang.String)
//  .allowDestroyPlan(java.lang.Boolean)
//  .allowDestroyPlan(IResolvable)
//  .assessmentsEnabled(java.lang.Boolean)
//  .assessmentsEnabled(IResolvable)
//  .autoApply(java.lang.Boolean)
//  .autoApply(IResolvable)
//  .autoApplyRunTrigger(java.lang.Boolean)
//  .autoApplyRunTrigger(IResolvable)
//  .autoDestroyActivityDuration(java.lang.String)
//  .autoDestroyAt(java.lang.String)
//  .description(java.lang.String)
//  .executionMode(java.lang.String)
//  .fileTriggersEnabled(java.lang.Boolean)
//  .fileTriggersEnabled(IResolvable)
//  .forceDelete(java.lang.Boolean)
//  .forceDelete(IResolvable)
//  .globalRemoteState(java.lang.Boolean)
//  .globalRemoteState(IResolvable)
//  .id(java.lang.String)
//  .ignoreAdditionalTagNames(java.lang.Boolean)
//  .ignoreAdditionalTagNames(IResolvable)
//  .operations(java.lang.Boolean)
//  .operations(IResolvable)
//  .organization(java.lang.String)
//  .projectId(java.lang.String)
//  .queueAllRuns(java.lang.Boolean)
//  .queueAllRuns(IResolvable)
//  .remoteStateConsumerIds(java.util.List<java.lang.String>)
//  .sourceName(java.lang.String)
//  .sourceUrl(java.lang.String)
//  .speculativeEnabled(java.lang.Boolean)
//  .speculativeEnabled(IResolvable)
//  .sshKeyId(java.lang.String)
//  .structuredRunOutputEnabled(java.lang.Boolean)
//  .structuredRunOutputEnabled(IResolvable)
//  .tagNames(java.util.List<java.lang.String>)
//  .terraformVersion(java.lang.String)
//  .triggerPatterns(java.util.List<java.lang.String>)
//  .triggerPrefixes(java.util.List<java.lang.String>)
//  .vcsRepo(WorkspaceVcsRepo)
//  .workingDirectory(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#name Workspace#name}.
agentPoolId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#agent_pool_id Workspace#agent_pool_id}.
allowDestroyPlan java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#allow_destroy_plan Workspace#allow_destroy_plan}.
assessmentsEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#assessments_enabled Workspace#assessments_enabled}.
autoApply java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_apply Workspace#auto_apply}.
autoApplyRunTrigger java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_apply_run_trigger Workspace#auto_apply_run_trigger}.
autoDestroyActivityDuration java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_destroy_activity_duration Workspace#auto_destroy_activity_duration}.
autoDestroyAt java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_destroy_at Workspace#auto_destroy_at}.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#description Workspace#description}.
executionMode java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#execution_mode Workspace#execution_mode}.
fileTriggersEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#file_triggers_enabled Workspace#file_triggers_enabled}.
forceDelete java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#force_delete Workspace#force_delete}.
globalRemoteState java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#global_remote_state Workspace#global_remote_state}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#id Workspace#id}.
ignoreAdditionalTagNames java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ignore_additional_tag_names Workspace#ignore_additional_tag_names}.
operations java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#operations Workspace#operations}.
organization java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#organization Workspace#organization}.
projectId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#project_id Workspace#project_id}.
queueAllRuns java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#queue_all_runs Workspace#queue_all_runs}.
remoteStateConsumerIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#remote_state_consumer_ids Workspace#remote_state_consumer_ids}.
sourceName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#source_name Workspace#source_name}.
sourceUrl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#source_url Workspace#source_url}.
speculativeEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#speculative_enabled Workspace#speculative_enabled}.
sshKeyId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ssh_key_id Workspace#ssh_key_id}.
structuredRunOutputEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#structured_run_output_enabled Workspace#structured_run_output_enabled}.
tagNames java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#tag_names Workspace#tag_names}.
terraformVersion java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#terraform_version Workspace#terraform_version}.
triggerPatterns java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#trigger_patterns Workspace#trigger_patterns}.
triggerPrefixes java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#trigger_prefixes Workspace#trigger_prefixes}.
vcsRepo WorkspaceVcsRepo vcs_repo block.
workingDirectory java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#working_directory Workspace#working_directory}.

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

nameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#name Workspace#name}.


agentPoolIdOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#agent_pool_id Workspace#agent_pool_id}.


allowDestroyPlanOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#allow_destroy_plan Workspace#allow_destroy_plan}.


assessmentsEnabledOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#assessments_enabled Workspace#assessments_enabled}.


autoApplyOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_apply Workspace#auto_apply}.


autoApplyRunTriggerOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_apply_run_trigger Workspace#auto_apply_run_trigger}.


autoDestroyActivityDurationOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_destroy_activity_duration Workspace#auto_destroy_activity_duration}.


autoDestroyAtOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_destroy_at Workspace#auto_destroy_at}.


descriptionOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#description Workspace#description}.


executionModeOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#execution_mode Workspace#execution_mode}.


fileTriggersEnabledOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#file_triggers_enabled Workspace#file_triggers_enabled}.


forceDeleteOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#force_delete Workspace#force_delete}.


globalRemoteStateOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#global_remote_state Workspace#global_remote_state}.


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#id Workspace#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


ignoreAdditionalTagNamesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ignore_additional_tag_names Workspace#ignore_additional_tag_names}.


operationsOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#operations Workspace#operations}.


organizationOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#organization Workspace#organization}.


projectIdOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#project_id Workspace#project_id}.


queueAllRunsOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#queue_all_runs Workspace#queue_all_runs}.


remoteStateConsumerIdsOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#remote_state_consumer_ids Workspace#remote_state_consumer_ids}.


sourceNameOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#source_name Workspace#source_name}.


sourceUrlOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#source_url Workspace#source_url}.


speculativeEnabledOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#speculative_enabled Workspace#speculative_enabled}.


sshKeyIdOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ssh_key_id Workspace#ssh_key_id}.


structuredRunOutputEnabledOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#structured_run_output_enabled Workspace#structured_run_output_enabled}.


tagNamesOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#tag_names Workspace#tag_names}.


terraformVersionOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#terraform_version Workspace#terraform_version}.


triggerPatternsOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#trigger_patterns Workspace#trigger_patterns}.


triggerPrefixesOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#trigger_prefixes Workspace#trigger_prefixes}.


vcsRepoOptional

vcs_repo block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#vcs_repo Workspace#vcs_repo}


workingDirectoryOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#working_directory Workspace#working_directory}.


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".
putVcsRepo No description.
resetAgentPoolId No description.
resetAllowDestroyPlan No description.
resetAssessmentsEnabled No description.
resetAutoApply No description.
resetAutoApplyRunTrigger No description.
resetAutoDestroyActivityDuration No description.
resetAutoDestroyAt No description.
resetDescription No description.
resetExecutionMode No description.
resetFileTriggersEnabled No description.
resetForceDelete No description.
resetGlobalRemoteState No description.
resetId No description.
resetIgnoreAdditionalTagNames No description.
resetOperations No description.
resetOrganization No description.
resetProjectId No description.
resetQueueAllRuns No description.
resetRemoteStateConsumerIds No description.
resetSourceName No description.
resetSourceUrl No description.
resetSpeculativeEnabled No description.
resetSshKeyId No description.
resetStructuredRunOutputEnabled No description.
resetTagNames No description.
resetTerraformVersion No description.
resetTriggerPatterns No description.
resetTriggerPrefixes No description.
resetVcsRepo No description.
resetWorkingDirectory No description.

toString
public java.lang.String toString()

Returns a string representation of this construct.

addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.


resetOverrideLogicalId
public void resetOverrideLogicalId()

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

toHclTerraform
public java.lang.Object toHclTerraform()
toMetadata
public java.lang.Object toMetadata()
toTerraform
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget
public void addMoveTarget(java.lang.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.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.


getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

hasResourceMove
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

moveFromId
public void moveFromId(java.lang.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.

idRequired
  • Type: java.lang.String

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


moveTo
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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


indexOptional
  • Type: java.lang.String OR java.lang.Number

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


moveToId
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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


putVcsRepo
public void putVcsRepo(WorkspaceVcsRepo value)
valueRequired

resetAgentPoolId
public void resetAgentPoolId()
resetAllowDestroyPlan
public void resetAllowDestroyPlan()
resetAssessmentsEnabled
public void resetAssessmentsEnabled()
resetAutoApply
public void resetAutoApply()
resetAutoApplyRunTrigger
public void resetAutoApplyRunTrigger()
resetAutoDestroyActivityDuration
public void resetAutoDestroyActivityDuration()
resetAutoDestroyAt
public void resetAutoDestroyAt()
resetDescription
public void resetDescription()
resetExecutionMode
public void resetExecutionMode()
resetFileTriggersEnabled
public void resetFileTriggersEnabled()
resetForceDelete
public void resetForceDelete()
resetGlobalRemoteState
public void resetGlobalRemoteState()
resetId
public void resetId()
resetIgnoreAdditionalTagNames
public void resetIgnoreAdditionalTagNames()
resetOperations
public void resetOperations()
resetOrganization
public void resetOrganization()
resetProjectId
public void resetProjectId()
resetQueueAllRuns
public void resetQueueAllRuns()
resetRemoteStateConsumerIds
public void resetRemoteStateConsumerIds()
resetSourceName
public void resetSourceName()
resetSourceUrl
public void resetSourceUrl()
resetSpeculativeEnabled
public void resetSpeculativeEnabled()
resetSshKeyId
public void resetSshKeyId()
resetStructuredRunOutputEnabled
public void resetStructuredRunOutputEnabled()
resetTagNames
public void resetTagNames()
resetTerraformVersion
public void resetTerraformVersion()
resetTriggerPatterns
public void resetTriggerPatterns()
resetTriggerPrefixes
public void resetTriggerPrefixes()
resetVcsRepo
public void resetVcsRepo()
resetWorkingDirectory
public void resetWorkingDirectory()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Workspace resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.tfe.workspace.Workspace;

Workspace.isConstruct(java.lang.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.

xRequired
  • Type: java.lang.Object

Any object.


isTerraformElement
import com.hashicorp.cdktf.providers.tfe.workspace.Workspace;

Workspace.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformResource
import com.hashicorp.cdktf.providers.tfe.workspace.Workspace;

Workspace.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.tfe.workspace.Workspace;

Workspace.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Workspace.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: java.lang.String

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing Workspace that should be imported.

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


providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
htmlUrl java.lang.String No description.
resourceCount java.lang.Number No description.
vcsRepo WorkspaceVcsRepoOutputReference No description.
agentPoolIdInput java.lang.String No description.
allowDestroyPlanInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
assessmentsEnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
autoApplyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
autoApplyRunTriggerInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
autoDestroyActivityDurationInput java.lang.String No description.
autoDestroyAtInput java.lang.String No description.
descriptionInput java.lang.String No description.
executionModeInput java.lang.String No description.
fileTriggersEnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
forceDeleteInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
globalRemoteStateInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
ignoreAdditionalTagNamesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
nameInput java.lang.String No description.
operationsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
organizationInput java.lang.String No description.
projectIdInput java.lang.String No description.
queueAllRunsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
remoteStateConsumerIdsInput java.util.List<java.lang.String> No description.
sourceNameInput java.lang.String No description.
sourceUrlInput java.lang.String No description.
speculativeEnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
sshKeyIdInput java.lang.String No description.
structuredRunOutputEnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tagNamesInput java.util.List<java.lang.String> No description.
terraformVersionInput java.lang.String No description.
triggerPatternsInput java.util.List<java.lang.String> No description.
triggerPrefixesInput java.util.List<java.lang.String> No description.
vcsRepoInput WorkspaceVcsRepo No description.
workingDirectoryInput java.lang.String No description.
agentPoolId java.lang.String No description.
allowDestroyPlan java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
assessmentsEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
autoApply java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
autoApplyRunTrigger java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
autoDestroyActivityDuration java.lang.String No description.
autoDestroyAt java.lang.String No description.
description java.lang.String No description.
executionMode java.lang.String No description.
fileTriggersEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
forceDelete java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
globalRemoteState java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
ignoreAdditionalTagNames java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
name java.lang.String No description.
operations java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
organization java.lang.String No description.
projectId java.lang.String No description.
queueAllRuns java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
remoteStateConsumerIds java.util.List<java.lang.String> No description.
sourceName java.lang.String No description.
sourceUrl java.lang.String No description.
speculativeEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
sshKeyId java.lang.String No description.
structuredRunOutputEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tagNames java.util.List<java.lang.String> No description.
terraformVersion java.lang.String No description.
triggerPatterns java.util.List<java.lang.String> No description.
triggerPrefixes java.util.List<java.lang.String> No description.
workingDirectory java.lang.String No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

htmlUrlRequired
public java.lang.String getHtmlUrl();
  • Type: java.lang.String

resourceCountRequired
public java.lang.Number getResourceCount();
  • Type: java.lang.Number

vcsRepoRequired
public WorkspaceVcsRepoOutputReference getVcsRepo();

agentPoolIdInputOptional
public java.lang.String getAgentPoolIdInput();
  • Type: java.lang.String

allowDestroyPlanInputOptional
public java.lang.Object getAllowDestroyPlanInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

assessmentsEnabledInputOptional
public java.lang.Object getAssessmentsEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

autoApplyInputOptional
public java.lang.Object getAutoApplyInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

autoApplyRunTriggerInputOptional
public java.lang.Object getAutoApplyRunTriggerInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

autoDestroyActivityDurationInputOptional
public java.lang.String getAutoDestroyActivityDurationInput();
  • Type: java.lang.String

autoDestroyAtInputOptional
public java.lang.String getAutoDestroyAtInput();
  • Type: java.lang.String

descriptionInputOptional
public java.lang.String getDescriptionInput();
  • Type: java.lang.String

executionModeInputOptional
public java.lang.String getExecutionModeInput();
  • Type: java.lang.String

fileTriggersEnabledInputOptional
public java.lang.Object getFileTriggersEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

forceDeleteInputOptional
public java.lang.Object getForceDeleteInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

globalRemoteStateInputOptional
public java.lang.Object getGlobalRemoteStateInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

ignoreAdditionalTagNamesInputOptional
public java.lang.Object getIgnoreAdditionalTagNamesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

nameInputOptional
public java.lang.String getNameInput();
  • Type: java.lang.String

operationsInputOptional
public java.lang.Object getOperationsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

organizationInputOptional
public java.lang.String getOrganizationInput();
  • Type: java.lang.String

projectIdInputOptional
public java.lang.String getProjectIdInput();
  • Type: java.lang.String

queueAllRunsInputOptional
public java.lang.Object getQueueAllRunsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

remoteStateConsumerIdsInputOptional
public java.util.List<java.lang.String> getRemoteStateConsumerIdsInput();
  • Type: java.util.List<java.lang.String>

sourceNameInputOptional
public java.lang.String getSourceNameInput();
  • Type: java.lang.String

sourceUrlInputOptional
public java.lang.String getSourceUrlInput();
  • Type: java.lang.String

speculativeEnabledInputOptional
public java.lang.Object getSpeculativeEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

sshKeyIdInputOptional
public java.lang.String getSshKeyIdInput();
  • Type: java.lang.String

structuredRunOutputEnabledInputOptional
public java.lang.Object getStructuredRunOutputEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

tagNamesInputOptional
public java.util.List<java.lang.String> getTagNamesInput();
  • Type: java.util.List<java.lang.String>

terraformVersionInputOptional
public java.lang.String getTerraformVersionInput();
  • Type: java.lang.String

triggerPatternsInputOptional
public java.util.List<java.lang.String> getTriggerPatternsInput();
  • Type: java.util.List<java.lang.String>

triggerPrefixesInputOptional
public java.util.List<java.lang.String> getTriggerPrefixesInput();
  • Type: java.util.List<java.lang.String>

vcsRepoInputOptional
public WorkspaceVcsRepo getVcsRepoInput();

workingDirectoryInputOptional
public java.lang.String getWorkingDirectoryInput();
  • Type: java.lang.String

agentPoolIdRequired
public java.lang.String getAgentPoolId();
  • Type: java.lang.String

allowDestroyPlanRequired
public java.lang.Object getAllowDestroyPlan();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

assessmentsEnabledRequired
public java.lang.Object getAssessmentsEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

autoApplyRequired
public java.lang.Object getAutoApply();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

autoApplyRunTriggerRequired
public java.lang.Object getAutoApplyRunTrigger();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

autoDestroyActivityDurationRequired
public java.lang.String getAutoDestroyActivityDuration();
  • Type: java.lang.String

autoDestroyAtRequired
public java.lang.String getAutoDestroyAt();
  • Type: java.lang.String

descriptionRequired
public java.lang.String getDescription();
  • Type: java.lang.String

executionModeRequired
public java.lang.String getExecutionMode();
  • Type: java.lang.String

fileTriggersEnabledRequired
public java.lang.Object getFileTriggersEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

forceDeleteRequired
public java.lang.Object getForceDelete();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

globalRemoteStateRequired
public java.lang.Object getGlobalRemoteState();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

idRequired
public java.lang.String getId();
  • Type: java.lang.String

ignoreAdditionalTagNamesRequired
public java.lang.Object getIgnoreAdditionalTagNames();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

operationsRequired
public java.lang.Object getOperations();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

organizationRequired
public java.lang.String getOrganization();
  • Type: java.lang.String

projectIdRequired
public java.lang.String getProjectId();
  • Type: java.lang.String

queueAllRunsRequired
public java.lang.Object getQueueAllRuns();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

remoteStateConsumerIdsRequired
public java.util.List<java.lang.String> getRemoteStateConsumerIds();
  • Type: java.util.List<java.lang.String>

sourceNameRequired
public java.lang.String getSourceName();
  • Type: java.lang.String

sourceUrlRequired
public java.lang.String getSourceUrl();
  • Type: java.lang.String

speculativeEnabledRequired
public java.lang.Object getSpeculativeEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

sshKeyIdRequired
public java.lang.String getSshKeyId();
  • Type: java.lang.String

structuredRunOutputEnabledRequired
public java.lang.Object getStructuredRunOutputEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

tagNamesRequired
public java.util.List<java.lang.String> getTagNames();
  • Type: java.util.List<java.lang.String>

terraformVersionRequired
public java.lang.String getTerraformVersion();
  • Type: java.lang.String

triggerPatternsRequired
public java.util.List<java.lang.String> getTriggerPatterns();
  • Type: java.util.List<java.lang.String>

triggerPrefixesRequired
public java.util.List<java.lang.String> getTriggerPrefixes();
  • Type: java.util.List<java.lang.String>

workingDirectoryRequired
public java.lang.String getWorkingDirectory();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

WorkspaceConfig

Initializer

import com.hashicorp.cdktf.providers.tfe.workspace.WorkspaceConfig;

WorkspaceConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .agentPoolId(java.lang.String)
//  .allowDestroyPlan(java.lang.Boolean)
//  .allowDestroyPlan(IResolvable)
//  .assessmentsEnabled(java.lang.Boolean)
//  .assessmentsEnabled(IResolvable)
//  .autoApply(java.lang.Boolean)
//  .autoApply(IResolvable)
//  .autoApplyRunTrigger(java.lang.Boolean)
//  .autoApplyRunTrigger(IResolvable)
//  .autoDestroyActivityDuration(java.lang.String)
//  .autoDestroyAt(java.lang.String)
//  .description(java.lang.String)
//  .executionMode(java.lang.String)
//  .fileTriggersEnabled(java.lang.Boolean)
//  .fileTriggersEnabled(IResolvable)
//  .forceDelete(java.lang.Boolean)
//  .forceDelete(IResolvable)
//  .globalRemoteState(java.lang.Boolean)
//  .globalRemoteState(IResolvable)
//  .id(java.lang.String)
//  .ignoreAdditionalTagNames(java.lang.Boolean)
//  .ignoreAdditionalTagNames(IResolvable)
//  .operations(java.lang.Boolean)
//  .operations(IResolvable)
//  .organization(java.lang.String)
//  .projectId(java.lang.String)
//  .queueAllRuns(java.lang.Boolean)
//  .queueAllRuns(IResolvable)
//  .remoteStateConsumerIds(java.util.List<java.lang.String>)
//  .sourceName(java.lang.String)
//  .sourceUrl(java.lang.String)
//  .speculativeEnabled(java.lang.Boolean)
//  .speculativeEnabled(IResolvable)
//  .sshKeyId(java.lang.String)
//  .structuredRunOutputEnabled(java.lang.Boolean)
//  .structuredRunOutputEnabled(IResolvable)
//  .tagNames(java.util.List<java.lang.String>)
//  .terraformVersion(java.lang.String)
//  .triggerPatterns(java.util.List<java.lang.String>)
//  .triggerPrefixes(java.util.List<java.lang.String>)
//  .vcsRepo(WorkspaceVcsRepo)
//  .workingDirectory(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#name Workspace#name}.
agentPoolId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#agent_pool_id Workspace#agent_pool_id}.
allowDestroyPlan java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#allow_destroy_plan Workspace#allow_destroy_plan}.
assessmentsEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#assessments_enabled Workspace#assessments_enabled}.
autoApply java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_apply Workspace#auto_apply}.
autoApplyRunTrigger java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_apply_run_trigger Workspace#auto_apply_run_trigger}.
autoDestroyActivityDuration java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_destroy_activity_duration Workspace#auto_destroy_activity_duration}.
autoDestroyAt java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_destroy_at Workspace#auto_destroy_at}.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#description Workspace#description}.
executionMode java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#execution_mode Workspace#execution_mode}.
fileTriggersEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#file_triggers_enabled Workspace#file_triggers_enabled}.
forceDelete java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#force_delete Workspace#force_delete}.
globalRemoteState java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#global_remote_state Workspace#global_remote_state}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#id Workspace#id}.
ignoreAdditionalTagNames java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ignore_additional_tag_names Workspace#ignore_additional_tag_names}.
operations java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#operations Workspace#operations}.
organization java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#organization Workspace#organization}.
projectId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#project_id Workspace#project_id}.
queueAllRuns java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#queue_all_runs Workspace#queue_all_runs}.
remoteStateConsumerIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#remote_state_consumer_ids Workspace#remote_state_consumer_ids}.
sourceName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#source_name Workspace#source_name}.
sourceUrl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#source_url Workspace#source_url}.
speculativeEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#speculative_enabled Workspace#speculative_enabled}.
sshKeyId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ssh_key_id Workspace#ssh_key_id}.
structuredRunOutputEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#structured_run_output_enabled Workspace#structured_run_output_enabled}.
tagNames java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#tag_names Workspace#tag_names}.
terraformVersion java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#terraform_version Workspace#terraform_version}.
triggerPatterns java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#trigger_patterns Workspace#trigger_patterns}.
triggerPrefixes java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#trigger_prefixes Workspace#trigger_prefixes}.
vcsRepo WorkspaceVcsRepo vcs_repo block.
workingDirectory java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#working_directory Workspace#working_directory}.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#name Workspace#name}.


agentPoolIdOptional
public java.lang.String getAgentPoolId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#agent_pool_id Workspace#agent_pool_id}.


allowDestroyPlanOptional
public java.lang.Object getAllowDestroyPlan();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#allow_destroy_plan Workspace#allow_destroy_plan}.


assessmentsEnabledOptional
public java.lang.Object getAssessmentsEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#assessments_enabled Workspace#assessments_enabled}.


autoApplyOptional
public java.lang.Object getAutoApply();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_apply Workspace#auto_apply}.


autoApplyRunTriggerOptional
public java.lang.Object getAutoApplyRunTrigger();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_apply_run_trigger Workspace#auto_apply_run_trigger}.


autoDestroyActivityDurationOptional
public java.lang.String getAutoDestroyActivityDuration();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_destroy_activity_duration Workspace#auto_destroy_activity_duration}.


autoDestroyAtOptional
public java.lang.String getAutoDestroyAt();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#auto_destroy_at Workspace#auto_destroy_at}.


descriptionOptional
public java.lang.String getDescription();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#description Workspace#description}.


executionModeOptional
public java.lang.String getExecutionMode();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#execution_mode Workspace#execution_mode}.


fileTriggersEnabledOptional
public java.lang.Object getFileTriggersEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#file_triggers_enabled Workspace#file_triggers_enabled}.


forceDeleteOptional
public java.lang.Object getForceDelete();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#force_delete Workspace#force_delete}.


globalRemoteStateOptional
public java.lang.Object getGlobalRemoteState();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#global_remote_state Workspace#global_remote_state}.


idOptional
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#id Workspace#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


ignoreAdditionalTagNamesOptional
public java.lang.Object getIgnoreAdditionalTagNames();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ignore_additional_tag_names Workspace#ignore_additional_tag_names}.


operationsOptional
public java.lang.Object getOperations();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#operations Workspace#operations}.


organizationOptional
public java.lang.String getOrganization();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#organization Workspace#organization}.


projectIdOptional
public java.lang.String getProjectId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#project_id Workspace#project_id}.


queueAllRunsOptional
public java.lang.Object getQueueAllRuns();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#queue_all_runs Workspace#queue_all_runs}.


remoteStateConsumerIdsOptional
public java.util.List<java.lang.String> getRemoteStateConsumerIds();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#remote_state_consumer_ids Workspace#remote_state_consumer_ids}.


sourceNameOptional
public java.lang.String getSourceName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#source_name Workspace#source_name}.


sourceUrlOptional
public java.lang.String getSourceUrl();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#source_url Workspace#source_url}.


speculativeEnabledOptional
public java.lang.Object getSpeculativeEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#speculative_enabled Workspace#speculative_enabled}.


sshKeyIdOptional
public java.lang.String getSshKeyId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ssh_key_id Workspace#ssh_key_id}.


structuredRunOutputEnabledOptional
public java.lang.Object getStructuredRunOutputEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#structured_run_output_enabled Workspace#structured_run_output_enabled}.


tagNamesOptional
public java.util.List<java.lang.String> getTagNames();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#tag_names Workspace#tag_names}.


terraformVersionOptional
public java.lang.String getTerraformVersion();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#terraform_version Workspace#terraform_version}.


triggerPatternsOptional
public java.util.List<java.lang.String> getTriggerPatterns();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#trigger_patterns Workspace#trigger_patterns}.


triggerPrefixesOptional
public java.util.List<java.lang.String> getTriggerPrefixes();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#trigger_prefixes Workspace#trigger_prefixes}.


vcsRepoOptional
public WorkspaceVcsRepo getVcsRepo();

vcs_repo block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#vcs_repo Workspace#vcs_repo}


workingDirectoryOptional
public java.lang.String getWorkingDirectory();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#working_directory Workspace#working_directory}.


WorkspaceVcsRepo

Initializer

import com.hashicorp.cdktf.providers.tfe.workspace.WorkspaceVcsRepo;

WorkspaceVcsRepo.builder()
    .identifier(java.lang.String)
//  .branch(java.lang.String)
//  .githubAppInstallationId(java.lang.String)
//  .ingressSubmodules(java.lang.Boolean)
//  .ingressSubmodules(IResolvable)
//  .oauthTokenId(java.lang.String)
//  .tagsRegex(java.lang.String)
    .build();

Properties

Name Type Description
identifier java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#identifier Workspace#identifier}.
branch java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#branch Workspace#branch}.
githubAppInstallationId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#github_app_installation_id Workspace#github_app_installation_id}.
ingressSubmodules java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ingress_submodules Workspace#ingress_submodules}.
oauthTokenId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#oauth_token_id Workspace#oauth_token_id}.
tagsRegex java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#tags_regex Workspace#tags_regex}.

identifierRequired
public java.lang.String getIdentifier();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#identifier Workspace#identifier}.


branchOptional
public java.lang.String getBranch();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#branch Workspace#branch}.


githubAppInstallationIdOptional
public java.lang.String getGithubAppInstallationId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#github_app_installation_id Workspace#github_app_installation_id}.


ingressSubmodulesOptional
public java.lang.Object getIngressSubmodules();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#ingress_submodules Workspace#ingress_submodules}.


oauthTokenIdOptional
public java.lang.String getOauthTokenId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#oauth_token_id Workspace#oauth_token_id}.


tagsRegexOptional
public java.lang.String getTagsRegex();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace#tags_regex Workspace#tags_regex}.


Classes

WorkspaceVcsRepoOutputReference

Initializers

import com.hashicorp.cdktf.providers.tfe.workspace.WorkspaceVcsRepoOutputReference;

new WorkspaceVcsRepoOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.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.
resetBranch No description.
resetGithubAppInstallationId No description.
resetIngressSubmodules No description.
resetOauthTokenId No description.
resetTagsRegex No description.

computeFqn
public java.lang.String computeFqn()
getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String

resolve
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetBranch
public void resetBranch()
resetGithubAppInstallationId
public void resetGithubAppInstallationId()
resetIngressSubmodules
public void resetIngressSubmodules()
resetOauthTokenId
public void resetOauthTokenId()
resetTagsRegex
public void resetTagsRegex()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
branchInput java.lang.String No description.
githubAppInstallationIdInput java.lang.String No description.
identifierInput java.lang.String No description.
ingressSubmodulesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
oauthTokenIdInput java.lang.String No description.
tagsRegexInput java.lang.String No description.
branch java.lang.String No description.
githubAppInstallationId java.lang.String No description.
identifier java.lang.String No description.
ingressSubmodules java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
oauthTokenId java.lang.String No description.
tagsRegex java.lang.String No description.
internalValue WorkspaceVcsRepo No description.

creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.


fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

branchInputOptional
public java.lang.String getBranchInput();
  • Type: java.lang.String

githubAppInstallationIdInputOptional
public java.lang.String getGithubAppInstallationIdInput();
  • Type: java.lang.String

identifierInputOptional
public java.lang.String getIdentifierInput();
  • Type: java.lang.String

ingressSubmodulesInputOptional
public java.lang.Object getIngressSubmodulesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

oauthTokenIdInputOptional
public java.lang.String getOauthTokenIdInput();
  • Type: java.lang.String

tagsRegexInputOptional
public java.lang.String getTagsRegexInput();
  • Type: java.lang.String

branchRequired
public java.lang.String getBranch();
  • Type: java.lang.String

githubAppInstallationIdRequired
public java.lang.String getGithubAppInstallationId();
  • Type: java.lang.String

identifierRequired
public java.lang.String getIdentifier();
  • Type: java.lang.String

ingressSubmodulesRequired
public java.lang.Object getIngressSubmodules();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

oauthTokenIdRequired
public java.lang.String getOauthTokenId();
  • Type: java.lang.String

tagsRegexRequired
public java.lang.String getTagsRegex();
  • Type: java.lang.String

internalValueOptional
public WorkspaceVcsRepo getInternalValue();