groupCluster.csharp.md

groupCluster Submodule

Constructs

GroupCluster

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster gitlab_group_cluster}.

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new GroupCluster(Construct Scope, string Id, GroupClusterConfig Config);

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

---

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".
ResetDomain	No description.
ResetEnabled	No description.
ResetEnvironmentScope	No description.
ResetId	No description.
ResetKubernetesAuthorizationType	No description.
ResetKubernetesCaCert	No description.
ResetManaged	No description.
ResetManagementProjectId	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".

---

ResetDomain

private void ResetDomain()

ResetEnabled

private void ResetEnabled()

ResetEnvironmentScope

private void ResetEnvironmentScope()

ResetId

private void ResetId()

ResetKubernetesAuthorizationType

private void ResetKubernetesAuthorizationType()

ResetKubernetesCaCert

private void ResetKubernetesCaCert()

ResetManaged

private void ResetManaged()

ResetManagementProjectId

private void ResetManagementProjectId()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Gitlab;

GroupCluster.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;

GroupCluster.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Gitlab;

GroupCluster.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Gitlab;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing GroupCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#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 GroupCluster 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.
ClusterType	string	No description.
CreatedAt	string	No description.
PlatformType	string	No description.
ProviderType	string	No description.
DomainInput	string	No description.
EnabledInput	object	No description.
EnvironmentScopeInput	string	No description.
GroupInput	string	No description.
IdInput	string	No description.
KubernetesApiUrlInput	string	No description.
KubernetesAuthorizationTypeInput	string	No description.
KubernetesCaCertInput	string	No description.
KubernetesTokenInput	string	No description.
ManagedInput	object	No description.
ManagementProjectIdInput	string	No description.
NameInput	string	No description.
Domain	string	No description.
Enabled	object	No description.
EnvironmentScope	string	No description.
Group	string	No description.
Id	string	No description.
KubernetesApiUrl	string	No description.
KubernetesAuthorizationType	string	No description.
KubernetesCaCert	string	No description.
KubernetesToken	string	No description.
Managed	object	No description.
ManagementProjectId	string	No description.
Name	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[]

---

ClusterType^Required

public string ClusterType { get; }

• Type: string

---

CreatedAt^Required

public string CreatedAt { get; }

• Type: string

---

PlatformType^Required

public string PlatformType { get; }

• Type: string

---

ProviderType^Required

public string ProviderType { get; }

• Type: string

---

DomainInput^Optional

public string DomainInput { get; }

• Type: string

---

EnabledInput^Optional

public object EnabledInput { get; }

• Type: object

---

EnvironmentScopeInput^Optional

public string EnvironmentScopeInput { get; }

• Type: string

---

GroupInput^Optional

public string GroupInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

KubernetesApiUrlInput^Optional

public string KubernetesApiUrlInput { get; }

• Type: string

---

KubernetesAuthorizationTypeInput^Optional

public string KubernetesAuthorizationTypeInput { get; }

• Type: string

---

KubernetesCaCertInput^Optional

public string KubernetesCaCertInput { get; }

• Type: string

---

KubernetesTokenInput^Optional

public string KubernetesTokenInput { get; }

• Type: string

---

ManagedInput^Optional

public object ManagedInput { get; }

• Type: object

---

ManagementProjectIdInput^Optional

public string ManagementProjectIdInput { get; }

• Type: string

---

NameInput^Optional

public string NameInput { get; }

• Type: string

---

Domain^Required

public string Domain { get; }

• Type: string

---

Enabled^Required

public object Enabled { get; }

• Type: object

---

EnvironmentScope^Required

public string EnvironmentScope { get; }

• Type: string

---

Group^Required

public string Group { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

KubernetesApiUrl^Required

public string KubernetesApiUrl { get; }

• Type: string

---

KubernetesAuthorizationType^Required

public string KubernetesAuthorizationType { get; }

• Type: string

---

KubernetesCaCert^Required

public string KubernetesCaCert { get; }

• Type: string

---

KubernetesToken^Required

public string KubernetesToken { get; }

• Type: string

---

Managed^Required

public object Managed { get; }

• Type: object

---

ManagementProjectId^Required

public string ManagementProjectId { get; }

• Type: string

---

Name^Required

public string Name { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

GroupClusterConfig

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new GroupClusterConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Group,
    string KubernetesApiUrl,
    string KubernetesToken,
    string Name,
    string Domain = null,
    object Enabled = null,
    string EnvironmentScope = null,
    string Id = null,
    string KubernetesAuthorizationType = null,
    string KubernetesCaCert = null,
    object Managed = null,
    string ManagementProjectId = 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.
Group	string	The id of the group to add the cluster to.
KubernetesApiUrl	string	The URL to access the Kubernetes API.
KubernetesToken	string	The token to authenticate against Kubernetes.
Name	string	The name of cluster.
Domain	string	The base domain of the cluster.
Enabled	object	Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
EnvironmentScope	string	The associated environment to the cluster. Defaults to *.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#id GroupCluster#id}.
KubernetesAuthorizationType	string	The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
KubernetesCaCert	string	TLS certificate (needed if API is using a self-signed TLS certificate).
Managed	object	Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
ManagementProjectId	string	The ID of the management project for the cluster.

---

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[]

---

Group^Required

public string Group { get; set; }

• Type: string

The id of the group to add the cluster to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#group GroupCluster#group}

---

KubernetesApiUrl^Required

public string KubernetesApiUrl { get; set; }

• Type: string

The URL to access the Kubernetes API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#kubernetes_api_url GroupCluster#kubernetes_api_url}

---

KubernetesToken^Required

public string KubernetesToken { get; set; }

• Type: string

The token to authenticate against Kubernetes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#kubernetes_token GroupCluster#kubernetes_token}

---

Name^Required

public string Name { get; set; }

• Type: string

The name of cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#name GroupCluster#name}

---

Domain^Optional

public string Domain { get; set; }

• Type: string

The base domain of the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#domain GroupCluster#domain}

---

Enabled^Optional

public object Enabled { get; set; }

• Type: object

Determines if cluster is active or not. Defaults to true. This attribute cannot be read.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#enabled GroupCluster#enabled}

---

EnvironmentScope^Optional

public string EnvironmentScope { get; set; }

• Type: string

The associated environment to the cluster. Defaults to *.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#environment_scope GroupCluster#environment_scope}

---

Id^Optional

public string Id { get; set; }

• Type: string

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

---

KubernetesAuthorizationType^Optional

public string KubernetesAuthorizationType { get; set; }

• Type: string

The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#kubernetes_authorization_type GroupCluster#kubernetes_authorization_type}

---

KubernetesCaCert^Optional

public string KubernetesCaCert { get; set; }

• Type: string

TLS certificate (needed if API is using a self-signed TLS certificate).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#kubernetes_ca_cert GroupCluster#kubernetes_ca_cert}

---

Managed^Optional

public object Managed { get; set; }

• Type: object

Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#managed GroupCluster#managed}

---

ManagementProjectId^Optional

public string ManagementProjectId { get; set; }

• Type: string

The ID of the management project for the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.1/docs/resources/group_cluster#management_project_id GroupCluster#management_project_id}

---