workspaceSettings.csharp.md

workspaceSettings Submodule

Constructs

WorkspaceSettings

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

Initializers

using HashiCorp.Cdktf.Providers.Tfe;

new WorkspaceSettings(Construct Scope, string Id, WorkspaceSettingsConfig Config);

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

---

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

Id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

Config^Required

• Type: WorkspaceSettingsConfig

---

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".
ResetAgentPoolId	No description.
ResetExecutionMode	No description.
ResetGlobalRemoteState	No description.
ResetRemoteStateConsumerIds	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

ResetOverrideLogicalId

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

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

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

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

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

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

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

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

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

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

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

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

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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

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

Id^Required

• Type: string

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

---

MoveTo

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

Moves this resource to the target resource given by moveTarget.

MoveTarget^Required

• Type: string

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

---

Index^Optional

• Type: object

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

---

MoveToId

private void MoveToId(string Id)

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

Id^Required

• Type: string

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

---

ResetAgentPoolId

private void ResetAgentPoolId()

ResetExecutionMode

private void ResetExecutionMode()

ResetGlobalRemoteState

private void ResetGlobalRemoteState()

ResetRemoteStateConsumerIds

private void ResetRemoteStateConsumerIds()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Tfe;

WorkspaceSettings.IsConstruct(object X);

Checks if x is a construct.

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

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

X^Required

• Type: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Tfe;

WorkspaceSettings.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Tfe;

WorkspaceSettings.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Tfe;

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

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

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

ImportToId^Required

• Type: string

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

---

ImportFromId^Required

• Type: string

The id of the existing WorkspaceSettings that should be imported.

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

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	object	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Id	string	No description.
Overwrites	WorkspaceSettingsOverwritesList	No description.
AgentPoolIdInput	string	No description.
ExecutionModeInput	string	No description.
GlobalRemoteStateInput	object	No description.
RemoteStateConsumerIdsInput	string[]	No description.
WorkspaceIdInput	string	No description.
AgentPoolId	string	No description.
ExecutionMode	string	No description.
GlobalRemoteState	object	No description.
RemoteStateConsumerIds	string[]	No description.
WorkspaceId	string	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

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

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

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

Id^Required

public string Id { get; }

• Type: string

---

Overwrites^Required

public WorkspaceSettingsOverwritesList Overwrites { get; }

• Type: WorkspaceSettingsOverwritesList

---

AgentPoolIdInput^Optional

public string AgentPoolIdInput { get; }

• Type: string

---

ExecutionModeInput^Optional

public string ExecutionModeInput { get; }

• Type: string

---

GlobalRemoteStateInput^Optional

public object GlobalRemoteStateInput { get; }

• Type: object

---

RemoteStateConsumerIdsInput^Optional

public string[] RemoteStateConsumerIdsInput { get; }

• Type: string[]

---

WorkspaceIdInput^Optional

public string WorkspaceIdInput { get; }

• Type: string

---

AgentPoolId^Required

public string AgentPoolId { get; }

• Type: string

---

ExecutionMode^Required

public string ExecutionMode { get; }

• Type: string

---

GlobalRemoteState^Required

public object GlobalRemoteState { get; }

• Type: object

---

RemoteStateConsumerIds^Required

public string[] RemoteStateConsumerIds { get; }

• Type: string[]

---

WorkspaceId^Required

public string WorkspaceId { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

WorkspaceSettingsConfig

Initializer

using HashiCorp.Cdktf.Providers.Tfe;

new WorkspaceSettingsConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string WorkspaceId,
    string AgentPoolId = null,
    string ExecutionMode = null,
    object GlobalRemoteState = null,
    string[] RemoteStateConsumerIds = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
WorkspaceId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_settings#workspace_id WorkspaceSettings#workspace_id}.
AgentPoolId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_settings#agent_pool_id WorkspaceSettings#agent_pool_id}.
ExecutionMode	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/workspace_settings#execution_mode WorkspaceSettings#execution_mode}.
GlobalRemoteState	object	Whether the workspace allows all workspaces in the organization to access its state data during runs.
RemoteStateConsumerIds	string[]	The set of workspace IDs set as explicit remote state consumers for the given workspace.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

WorkspaceId^Required

public string WorkspaceId { get; set; }

• Type: string

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

---

AgentPoolId^Optional

public string AgentPoolId { get; set; }

• Type: string

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

---

ExecutionMode^Optional

public string ExecutionMode { get; set; }

• Type: string

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

---

GlobalRemoteState^Optional

public object GlobalRemoteState { get; set; }

• Type: object

Whether the workspace allows all workspaces in the organization to access its state data during runs.

If false, then only workspaces defined in remote_state_consumer_ids can access its state.

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

---

RemoteStateConsumerIds^Optional

public string[] RemoteStateConsumerIds { get; set; }

• Type: string[]

The set of workspace IDs set as explicit remote state consumers for the given workspace.

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

---

WorkspaceSettingsOverwrites

Initializer

using HashiCorp.Cdktf.Providers.Tfe;

new WorkspaceSettingsOverwrites {

};

Classes

WorkspaceSettingsOverwritesList

Initializers

using HashiCorp.Cdktf.Providers.Tfe;

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

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

---

TerraformResource^Required

• Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

---

TerraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

WrapsSet^Required

• Type: bool

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

---

Methods

Name	Description
AllWithMapKey	Creating an iterator for this complex list.
ComputeFqn	No description.
Resolve	Produce the Token's value at resolution time.
ToString	Return a string representation of this resolvable object.
Get	No description.

---

AllWithMapKey

private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

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

MapKeyAttributeName^Required

• Type: string

---

ComputeFqn

private string ComputeFqn()

Resolve

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

Context^Required

• Type: HashiCorp.Cdktf.IResolveContext

---

ToString

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get

private WorkspaceSettingsOverwritesOutputReference Get(double Index)

Index^Required

• Type: double

the index of the item to return.

---

Properties

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

---

CreationStack^Required

public string[] CreationStack { get; }

• Type: string[]

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

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

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

WorkspaceSettingsOverwritesOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Tfe;

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

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

---

TerraformResource^Required

• Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

---

TerraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

ComplexObjectIndex^Required

• Type: double

the index of this item in the list.

---

ComplexObjectIsFromSet^Required

• Type: bool

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

---

Methods

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

---

ComputeFqn

private string ComputeFqn()

GetAnyMapAttribute

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

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

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

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

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

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

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

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string Property)

Property^Required

• Type: string

---

Resolve

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

Context^Required

• Type: HashiCorp.Cdktf.IResolveContext

---

ToString

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
CreationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn	string	No description.
AgentPool	HashiCorp.Cdktf.IResolvable	No description.
ExecutionMode	HashiCorp.Cdktf.IResolvable	No description.
InternalValue	WorkspaceSettingsOverwrites	No description.

---

CreationStack^Required

public string[] CreationStack { get; }

• Type: string[]

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

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

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

AgentPool^Required

public IResolvable AgentPool { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

ExecutionMode^Required

public IResolvable ExecutionMode { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

InternalValue^Optional

public WorkspaceSettingsOverwrites InternalValue { get; }

• Type: WorkspaceSettingsOverwrites

---