Skip to content

Latest commit

 

History

History
1977 lines (1224 loc) · 83.2 KB

workspaceRun.typescript.md

File metadata and controls

1977 lines (1224 loc) · 83.2 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 { workspaceRun } from '@cdktf/provider-tfe'

new workspaceRun.WorkspaceRun(scope: Construct, id: string, config: WorkspaceRunConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config WorkspaceRunConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

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 toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

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: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

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: string

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

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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

indexOptional
  • Type: string | number

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

moveToId 
public moveToId(id: string): void

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

idRequired
  • Type: string

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

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

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 { workspaceRun } from '@cdktf/provider-tfe'

workspaceRun.WorkspaceRun.isConstruct(x: any)

Checks if x is a construct.

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

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

xRequired
  • Type: any

Any object.

isTerraformElement 
import { workspaceRun } from '@cdktf/provider-tfe'

workspaceRun.WorkspaceRun.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { workspaceRun } from '@cdktf/provider-tfe'

workspaceRun.WorkspaceRun.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { workspaceRun } from '@cdktf/provider-tfe'

workspaceRun.WorkspaceRun.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: 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: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
apply WorkspaceRunApplyOutputReference No description.
destroy WorkspaceRunDestroyOutputReference No description.
applyInput WorkspaceRunApply No description.
destroyInput WorkspaceRunDestroy No description.
idInput string No description.
workspaceIdInput string No description.
id string No description.
workspaceId string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
applyRequired 
public readonly apply: WorkspaceRunApplyOutputReference;
destroyRequired 
public readonly destroy: WorkspaceRunDestroyOutputReference;
applyInputOptional 
public readonly applyInput: WorkspaceRunApply;
destroyInputOptional 
public readonly destroyInput: WorkspaceRunDestroy;
idInputOptional 
public readonly idInput: string;
  • Type: string
workspaceIdInputOptional 
public readonly workspaceIdInput: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
workspaceIdRequired 
public readonly workspaceId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

WorkspaceRunApply

Initializer 

import { workspaceRun } from '@cdktf/provider-tfe'

const workspaceRunApply: workspaceRun.WorkspaceRunApply = { ... }

Properties

Name Type Description
manualConfirm boolean | 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 boolean | 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 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 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 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 boolean | 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 readonly manualConfirm: boolean | IResolvable;
  • Type: boolean | 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 readonly retry: boolean | IResolvable;
  • Type: boolean | 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 readonly retryAttempts: number;
  • Type: 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 readonly retryBackoffMax: number;
  • Type: 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 readonly retryBackoffMin: number;
  • Type: 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 readonly waitForRun: boolean | IResolvable;
  • Type: boolean | 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 { workspaceRun } from '@cdktf/provider-tfe'

const workspaceRunConfig: workspaceRun.WorkspaceRunConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
workspaceId 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 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 readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
workspaceIdRequired 
public readonly workspaceId: string;
  • Type: 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 readonly apply: WorkspaceRunApply;

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 readonly destroy: WorkspaceRunDestroy;

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 readonly id: string;
  • Type: 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 { workspaceRun } from '@cdktf/provider-tfe'

const workspaceRunDestroy: workspaceRun.WorkspaceRunDestroy = { ... }

Properties

Name Type Description
manualConfirm boolean | 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 boolean | 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 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 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 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 boolean | 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 readonly manualConfirm: boolean | IResolvable;
  • Type: boolean | 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 readonly retry: boolean | IResolvable;
  • Type: boolean | 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 readonly retryAttempts: number;
  • Type: 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 readonly retryBackoffMax: number;
  • Type: 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 readonly retryBackoffMin: number;
  • Type: 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 readonly waitForRun: boolean | IResolvable;
  • Type: boolean | 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 { workspaceRun } from '@cdktf/provider-tfe'

new workspaceRun.WorkspaceRunApplyOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetRetry No description.
resetRetryAttempts No description.
resetRetryBackoffMax No description.
resetRetryBackoffMin No description.
resetWaitForRun No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
manualConfirmInput boolean | cdktf.IResolvable No description.
retryAttemptsInput number No description.
retryBackoffMaxInput number No description.
retryBackoffMinInput number No description.
retryInput boolean | cdktf.IResolvable No description.
waitForRunInput boolean | cdktf.IResolvable No description.
manualConfirm boolean | cdktf.IResolvable No description.
retry boolean | cdktf.IResolvable No description.
retryAttempts number No description.
retryBackoffMax number No description.
retryBackoffMin number No description.
waitForRun boolean | cdktf.IResolvable No description.
internalValue WorkspaceRunApply No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

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

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

fqnRequired 
public readonly fqn: string;
  • Type: string
manualConfirmInputOptional 
public readonly manualConfirmInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
retryAttemptsInputOptional 
public readonly retryAttemptsInput: number;
  • Type: number
retryBackoffMaxInputOptional 
public readonly retryBackoffMaxInput: number;
  • Type: number
retryBackoffMinInputOptional 
public readonly retryBackoffMinInput: number;
  • Type: number
retryInputOptional 
public readonly retryInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
waitForRunInputOptional 
public readonly waitForRunInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
manualConfirmRequired 
public readonly manualConfirm: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
retryRequired 
public readonly retry: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
retryAttemptsRequired 
public readonly retryAttempts: number;
  • Type: number
retryBackoffMaxRequired 
public readonly retryBackoffMax: number;
  • Type: number
retryBackoffMinRequired 
public readonly retryBackoffMin: number;
  • Type: number
waitForRunRequired 
public readonly waitForRun: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: WorkspaceRunApply;

WorkspaceRunDestroyOutputReference

Initializers 

import { workspaceRun } from '@cdktf/provider-tfe'

new workspaceRun.WorkspaceRunDestroyOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetRetry No description.
resetRetryAttempts No description.
resetRetryBackoffMax No description.
resetRetryBackoffMin No description.
resetWaitForRun No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
manualConfirmInput boolean | cdktf.IResolvable No description.
retryAttemptsInput number No description.
retryBackoffMaxInput number No description.
retryBackoffMinInput number No description.
retryInput boolean | cdktf.IResolvable No description.
waitForRunInput boolean | cdktf.IResolvable No description.
manualConfirm boolean | cdktf.IResolvable No description.
retry boolean | cdktf.IResolvable No description.
retryAttempts number No description.
retryBackoffMax number No description.
retryBackoffMin number No description.
waitForRun boolean | cdktf.IResolvable No description.
internalValue WorkspaceRunDestroy No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

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

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

fqnRequired 
public readonly fqn: string;
  • Type: string
manualConfirmInputOptional 
public readonly manualConfirmInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
retryAttemptsInputOptional 
public readonly retryAttemptsInput: number;
  • Type: number
retryBackoffMaxInputOptional 
public readonly retryBackoffMaxInput: number;
  • Type: number
retryBackoffMinInputOptional 
public readonly retryBackoffMinInput: number;
  • Type: number
retryInputOptional 
public readonly retryInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
waitForRunInputOptional 
public readonly waitForRunInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
manualConfirmRequired 
public readonly manualConfirm: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
retryRequired 
public readonly retry: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
retryAttemptsRequired 
public readonly retryAttempts: number;
  • Type: number
retryBackoffMaxRequired 
public readonly retryBackoffMax: number;
  • Type: number
retryBackoffMinRequired 
public readonly retryBackoffMin: number;
  • Type: number
waitForRunRequired 
public readonly waitForRun: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: WorkspaceRunDestroy;