projectEnvironment.csharp.md

projectEnvironment Submodule

Constructs

ProjectEnvironment

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment gitlab_project_environment}.

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new ProjectEnvironment(Construct Scope, string Id, ProjectEnvironmentConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	ProjectEnvironmentConfig	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: ProjectEnvironmentConfig

---

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".
ResetClusterAgentId	No description.
ResetExternalUrl	No description.
ResetFluxResourcePath	No description.
ResetId	No description.
ResetKubernetesNamespace	No description.
ResetStopBeforeDestroy	No description.
ResetTier	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".

---

ResetClusterAgentId

private void ResetClusterAgentId()

ResetExternalUrl

private void ResetExternalUrl()

ResetFluxResourcePath

private void ResetFluxResourcePath()

ResetId

private void ResetId()

ResetKubernetesNamespace

private void ResetKubernetesNamespace()

ResetStopBeforeDestroy

private void ResetStopBeforeDestroy()

ResetTier

private void ResetTier()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Gitlab;

ProjectEnvironment.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.Gitlab;

ProjectEnvironment.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Gitlab;

ProjectEnvironment.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Gitlab;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing ProjectEnvironment that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#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 ProjectEnvironment 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.
CreatedAt	string	No description.
Slug	string	No description.
State	string	No description.
UpdatedAt	string	No description.
ClusterAgentIdInput	double	No description.
ExternalUrlInput	string	No description.
FluxResourcePathInput	string	No description.
IdInput	string	No description.
KubernetesNamespaceInput	string	No description.
NameInput	string	No description.
ProjectInput	string	No description.
StopBeforeDestroyInput	object	No description.
TierInput	string	No description.
ClusterAgentId	double	No description.
ExternalUrl	string	No description.
FluxResourcePath	string	No description.
Id	string	No description.
KubernetesNamespace	string	No description.
Name	string	No description.
Project	string	No description.
StopBeforeDestroy	object	No description.
Tier	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[]

---

CreatedAt^Required

public string CreatedAt { get; }

• Type: string

---

Slug^Required

public string Slug { get; }

• Type: string

---

State^Required

public string State { get; }

• Type: string

---

UpdatedAt^Required

public string UpdatedAt { get; }

• Type: string

---

ClusterAgentIdInput^Optional

public double ClusterAgentIdInput { get; }

• Type: double

---

ExternalUrlInput^Optional

public string ExternalUrlInput { get; }

• Type: string

---

FluxResourcePathInput^Optional

public string FluxResourcePathInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

KubernetesNamespaceInput^Optional

public string KubernetesNamespaceInput { get; }

• Type: string

---

NameInput^Optional

public string NameInput { get; }

• Type: string

---

ProjectInput^Optional

public string ProjectInput { get; }

• Type: string

---

StopBeforeDestroyInput^Optional

public object StopBeforeDestroyInput { get; }

• Type: object

---

TierInput^Optional

public string TierInput { get; }

• Type: string

---

ClusterAgentId^Required

public double ClusterAgentId { get; }

• Type: double

---

ExternalUrl^Required

public string ExternalUrl { get; }

• Type: string

---

FluxResourcePath^Required

public string FluxResourcePath { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

KubernetesNamespace^Required

public string KubernetesNamespace { get; }

• Type: string

---

Name^Required

public string Name { get; }

• Type: string

---

Project^Required

public string Project { get; }

• Type: string

---

StopBeforeDestroy^Required

public object StopBeforeDestroy { get; }

• Type: object

---

Tier^Required

public string Tier { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

ProjectEnvironmentConfig

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new ProjectEnvironmentConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string Project,
    double ClusterAgentId = null,
    string ExternalUrl = null,
    string FluxResourcePath = null,
    string Id = null,
    string KubernetesNamespace = null,
    object StopBeforeDestroy = null,
    string Tier = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Name	string	The name of the environment.
Project	string	The ID or full path of the project to environment is created for.
ClusterAgentId	double	The cluster agent to associate with this environment.
ExternalUrl	string	Place to link to for this environment.
FluxResourcePath	string	The Flux resource path to associate with this environment.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#id ProjectEnvironment#id}.
KubernetesNamespace	string	The Kubernetes namespace to associate with this environment.
StopBeforeDestroy	object	Determines whether the environment is attempted to be stopped before the environment is deleted.
Tier	string	The tier of the new environment. Valid values are production, staging, testing, development, other.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

Name^Required

public string Name { get; set; }

• Type: string

The name of the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#name ProjectEnvironment#name}

---

Project^Required

public string Project { get; set; }

• Type: string

The ID or full path of the project to environment is created for.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#project ProjectEnvironment#project}

---

ClusterAgentId^Optional

public double ClusterAgentId { get; set; }

• Type: double

The cluster agent to associate with this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#cluster_agent_id ProjectEnvironment#cluster_agent_id}

---

ExternalUrl^Optional

public string ExternalUrl { get; set; }

• Type: string

Place to link to for this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#external_url ProjectEnvironment#external_url}

---

FluxResourcePath^Optional

public string FluxResourcePath { get; set; }

• Type: string

The Flux resource path to associate with this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#flux_resource_path ProjectEnvironment#flux_resource_path}

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#id ProjectEnvironment#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.

---

KubernetesNamespace^Optional

public string KubernetesNamespace { get; set; }

• Type: string

The Kubernetes namespace to associate with this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#kubernetes_namespace ProjectEnvironment#kubernetes_namespace}

---

StopBeforeDestroy^Optional

public object StopBeforeDestroy { get; set; }

• Type: object

Determines whether the environment is attempted to be stopped before the environment is deleted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#stop_before_destroy ProjectEnvironment#stop_before_destroy}

---

Tier^Optional

public string Tier { get; set; }

• Type: string

The tier of the new environment. Valid values are production, staging, testing, development, other.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_environment#tier ProjectEnvironment#tier}

---