Skip to content

Latest commit

 

History

History
2116 lines (1326 loc) · 93.4 KB

workspaceRun.java.md

File metadata and controls

2116 lines (1326 loc) · 93.4 KB

workspaceRun Submodule

Constructs

WorkspaceRun

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

Initializers 

import com.hashicorp.cdktf.providers.tfe.workspace_run.WorkspaceRun;

WorkspaceRun.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>)
    .workspaceId(java.lang.String)
//  .apply(WorkspaceRunApply)
//  .destroy(WorkspaceRunDestroy)
//  .id(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.
workspaceId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#workspace_id WorkspaceRun#workspace_id}.
apply WorkspaceRunApply apply block.
destroy WorkspaceRunDestroy destroy block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#id WorkspaceRun#id}.
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>
workspaceIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#workspace_id WorkspaceRun#workspace_id}.

applyOptional

apply block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#apply WorkspaceRun#apply}

destroyOptional

destroy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#destroy WorkspaceRun#destroy}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#id WorkspaceRun#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.

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".
putApply No description.
putDestroy No description.
resetApply No description.
resetDestroy No description.
resetId 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".

putApply 
public void putApply(WorkspaceRunApply value)
valueRequired
putDestroy 
public void putDestroy(WorkspaceRunDestroy value)
valueRequired
resetApply 
public void resetApply()
resetDestroy 
public void resetDestroy()
resetId 
public void resetId()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a WorkspaceRun resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.tfe.workspace_run.WorkspaceRun;

WorkspaceRun.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_run.WorkspaceRun;

WorkspaceRun.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.tfe.workspace_run.WorkspaceRun;

WorkspaceRun.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.tfe.workspace_run.WorkspaceRun;

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

Generates CDKTF code for importing a WorkspaceRun 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 WorkspaceRun to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing WorkspaceRun that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#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 WorkspaceRun 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.
apply WorkspaceRunApplyOutputReference No description.
destroy WorkspaceRunDestroyOutputReference No description.
applyInput WorkspaceRunApply No description.
destroyInput WorkspaceRunDestroy No description.
idInput java.lang.String No description.
workspaceIdInput java.lang.String No description.
id java.lang.String No description.
workspaceId 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>
applyRequired 
public WorkspaceRunApplyOutputReference getApply();
destroyRequired 
public WorkspaceRunDestroyOutputReference getDestroy();
applyInputOptional 
public WorkspaceRunApply getApplyInput();
destroyInputOptional 
public WorkspaceRunDestroy getDestroyInput();
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
workspaceIdInputOptional 
public java.lang.String getWorkspaceIdInput();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
workspaceIdRequired 
public java.lang.String getWorkspaceId();
  • 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

WorkspaceRunApply

Initializer 

import com.hashicorp.cdktf.providers.tfe.workspace_run.WorkspaceRunApply;

WorkspaceRunApply.builder()
    .manualConfirm(java.lang.Boolean)
    .manualConfirm(IResolvable)
//  .retry(java.lang.Boolean)
//  .retry(IResolvable)
//  .retryAttempts(java.lang.Number)
//  .retryBackoffMax(java.lang.Number)
//  .retryBackoffMin(java.lang.Number)
//  .waitForRun(java.lang.Boolean)
//  .waitForRun(IResolvable)
    .build();

Properties

Name Type Description
manualConfirm 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_run#manual_confirm WorkspaceRun#manual_confirm}.
retry 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_run#retry WorkspaceRun#retry}.
retryAttempts java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_attempts WorkspaceRun#retry_attempts}.
retryBackoffMax java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_backoff_max WorkspaceRun#retry_backoff_max}.
retryBackoffMin java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_backoff_min WorkspaceRun#retry_backoff_min}.
waitForRun 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_run#wait_for_run WorkspaceRun#wait_for_run}.
manualConfirmRequired 
public java.lang.Object getManualConfirm();
  • 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_run#manual_confirm WorkspaceRun#manual_confirm}.

retryOptional 
public java.lang.Object getRetry();
  • 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_run#retry WorkspaceRun#retry}.

retryAttemptsOptional 
public java.lang.Number getRetryAttempts();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_attempts WorkspaceRun#retry_attempts}.

retryBackoffMaxOptional 
public java.lang.Number getRetryBackoffMax();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_backoff_max WorkspaceRun#retry_backoff_max}.

retryBackoffMinOptional 
public java.lang.Number getRetryBackoffMin();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_backoff_min WorkspaceRun#retry_backoff_min}.

waitForRunOptional 
public java.lang.Object getWaitForRun();
  • 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_run#wait_for_run WorkspaceRun#wait_for_run}.

WorkspaceRunConfig

Initializer 

import com.hashicorp.cdktf.providers.tfe.workspace_run.WorkspaceRunConfig;

WorkspaceRunConfig.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>)
    .workspaceId(java.lang.String)
//  .apply(WorkspaceRunApply)
//  .destroy(WorkspaceRunDestroy)
//  .id(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.
workspaceId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#workspace_id WorkspaceRun#workspace_id}.
apply WorkspaceRunApply apply block.
destroy WorkspaceRunDestroy destroy block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#id WorkspaceRun#id}.
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>
workspaceIdRequired 
public java.lang.String getWorkspaceId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#workspace_id WorkspaceRun#workspace_id}.

applyOptional 
public WorkspaceRunApply getApply();

apply block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#apply WorkspaceRun#apply}

destroyOptional 
public WorkspaceRunDestroy getDestroy();

destroy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#destroy WorkspaceRun#destroy}

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_run#id WorkspaceRun#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.

WorkspaceRunDestroy

Initializer 

import com.hashicorp.cdktf.providers.tfe.workspace_run.WorkspaceRunDestroy;

WorkspaceRunDestroy.builder()
    .manualConfirm(java.lang.Boolean)
    .manualConfirm(IResolvable)
//  .retry(java.lang.Boolean)
//  .retry(IResolvable)
//  .retryAttempts(java.lang.Number)
//  .retryBackoffMax(java.lang.Number)
//  .retryBackoffMin(java.lang.Number)
//  .waitForRun(java.lang.Boolean)
//  .waitForRun(IResolvable)
    .build();

Properties

Name Type Description
manualConfirm 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_run#manual_confirm WorkspaceRun#manual_confirm}.
retry 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_run#retry WorkspaceRun#retry}.
retryAttempts java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_attempts WorkspaceRun#retry_attempts}.
retryBackoffMax java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_backoff_max WorkspaceRun#retry_backoff_max}.
retryBackoffMin java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_backoff_min WorkspaceRun#retry_backoff_min}.
waitForRun 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_run#wait_for_run WorkspaceRun#wait_for_run}.
manualConfirmRequired 
public java.lang.Object getManualConfirm();
  • 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_run#manual_confirm WorkspaceRun#manual_confirm}.

retryOptional 
public java.lang.Object getRetry();
  • 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_run#retry WorkspaceRun#retry}.

retryAttemptsOptional 
public java.lang.Number getRetryAttempts();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_attempts WorkspaceRun#retry_attempts}.

retryBackoffMaxOptional 
public java.lang.Number getRetryBackoffMax();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_backoff_max WorkspaceRun#retry_backoff_max}.

retryBackoffMinOptional 
public java.lang.Number getRetryBackoffMin();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_run#retry_backoff_min WorkspaceRun#retry_backoff_min}.

waitForRunOptional 
public java.lang.Object getWaitForRun();
  • 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_run#wait_for_run WorkspaceRun#wait_for_run}.

Classes

WorkspaceRunApplyOutputReference

Initializers 

import com.hashicorp.cdktf.providers.tfe.workspace_run.WorkspaceRunApplyOutputReference;

new WorkspaceRunApplyOutputReference(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.
resetRetry No description.
resetRetryAttempts No description.
resetRetryBackoffMax No description.
resetRetryBackoffMin No description.
resetWaitForRun 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.

resetRetry 
public void resetRetry()
resetRetryAttempts 
public void resetRetryAttempts()
resetRetryBackoffMax 
public void resetRetryBackoffMax()
resetRetryBackoffMin 
public void resetRetryBackoffMin()
resetWaitForRun 
public void resetWaitForRun()

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.
manualConfirmInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
retryAttemptsInput java.lang.Number No description.
retryBackoffMaxInput java.lang.Number No description.
retryBackoffMinInput java.lang.Number No description.
retryInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
waitForRunInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
manualConfirm java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
retry java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
retryAttempts java.lang.Number No description.
retryBackoffMax java.lang.Number No description.
retryBackoffMin java.lang.Number No description.
waitForRun java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
internalValue WorkspaceRunApply 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
manualConfirmInputOptional 
public java.lang.Object getManualConfirmInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
retryAttemptsInputOptional 
public java.lang.Number getRetryAttemptsInput();
  • Type: java.lang.Number
retryBackoffMaxInputOptional 
public java.lang.Number getRetryBackoffMaxInput();
  • Type: java.lang.Number
retryBackoffMinInputOptional 
public java.lang.Number getRetryBackoffMinInput();
  • Type: java.lang.Number
retryInputOptional 
public java.lang.Object getRetryInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
waitForRunInputOptional 
public java.lang.Object getWaitForRunInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
manualConfirmRequired 
public java.lang.Object getManualConfirm();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
retryRequired 
public java.lang.Object getRetry();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
retryAttemptsRequired 
public java.lang.Number getRetryAttempts();
  • Type: java.lang.Number
retryBackoffMaxRequired 
public java.lang.Number getRetryBackoffMax();
  • Type: java.lang.Number
retryBackoffMinRequired 
public java.lang.Number getRetryBackoffMin();
  • Type: java.lang.Number
waitForRunRequired 
public java.lang.Object getWaitForRun();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
internalValueOptional 
public WorkspaceRunApply getInternalValue();

WorkspaceRunDestroyOutputReference

Initializers 

import com.hashicorp.cdktf.providers.tfe.workspace_run.WorkspaceRunDestroyOutputReference;

new WorkspaceRunDestroyOutputReference(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.
resetRetry No description.
resetRetryAttempts No description.
resetRetryBackoffMax No description.
resetRetryBackoffMin No description.
resetWaitForRun 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.

resetRetry 
public void resetRetry()
resetRetryAttempts 
public void resetRetryAttempts()
resetRetryBackoffMax 
public void resetRetryBackoffMax()
resetRetryBackoffMin 
public void resetRetryBackoffMin()
resetWaitForRun 
public void resetWaitForRun()

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.
manualConfirmInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
retryAttemptsInput java.lang.Number No description.
retryBackoffMaxInput java.lang.Number No description.
retryBackoffMinInput java.lang.Number No description.
retryInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
waitForRunInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
manualConfirm java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
retry java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
retryAttempts java.lang.Number No description.
retryBackoffMax java.lang.Number No description.
retryBackoffMin java.lang.Number No description.
waitForRun java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
internalValue WorkspaceRunDestroy 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
manualConfirmInputOptional 
public java.lang.Object getManualConfirmInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
retryAttemptsInputOptional 
public java.lang.Number getRetryAttemptsInput();
  • Type: java.lang.Number
retryBackoffMaxInputOptional 
public java.lang.Number getRetryBackoffMaxInput();
  • Type: java.lang.Number
retryBackoffMinInputOptional 
public java.lang.Number getRetryBackoffMinInput();
  • Type: java.lang.Number
retryInputOptional 
public java.lang.Object getRetryInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
waitForRunInputOptional 
public java.lang.Object getWaitForRunInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
manualConfirmRequired 
public java.lang.Object getManualConfirm();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
retryRequired 
public java.lang.Object getRetry();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
retryAttemptsRequired 
public java.lang.Number getRetryAttempts();
  • Type: java.lang.Number
retryBackoffMaxRequired 
public java.lang.Number getRetryBackoffMax();
  • Type: java.lang.Number
retryBackoffMinRequired 
public java.lang.Number getRetryBackoffMin();
  • Type: java.lang.Number
waitForRunRequired 
public java.lang.Object getWaitForRun();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
internalValueOptional 
public WorkspaceRunDestroy getInternalValue();