projectCluster.typescript.md

projectCluster Submodule

Constructs

ProjectCluster

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster gitlab_project_cluster}.

Initializers

import { projectCluster } from '@cdktf/provider-gitlab'

new projectCluster.ProjectCluster(scope: Construct, id: string, config: ProjectClusterConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	ProjectClusterConfig	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: ProjectClusterConfig

---

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.
resetKubernetesNamespace	No description.
resetManaged	No description.
resetManagementProjectId	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

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.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• 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.

id^Required

• 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.

moveTarget^Required

• Type: string

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

---

index^Optional

• 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".

id^Required

• Type: string

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

---

resetDomain

public resetDomain(): void

resetEnabled

public resetEnabled(): void

resetEnvironmentScope

public resetEnvironmentScope(): void

resetId

public resetId(): void

resetKubernetesAuthorizationType

public resetKubernetesAuthorizationType(): void

resetKubernetesCaCert

public resetKubernetesCaCert(): void

resetKubernetesNamespace

public resetKubernetesNamespace(): void

resetManaged

public resetManaged(): void

resetManagementProjectId

public resetManagementProjectId(): 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 ProjectCluster resource upon running "cdktf plan ".

---

isConstruct

import { projectCluster } from '@cdktf/provider-gitlab'

projectCluster.ProjectCluster.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { projectCluster } from '@cdktf/provider-gitlab'

projectCluster.ProjectCluster.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { projectCluster } from '@cdktf/provider-gitlab'

projectCluster.ProjectCluster.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { projectCluster } from '@cdktf/provider-gitlab'

projectCluster.ProjectCluster.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing ProjectCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the ProjectCluster 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.
clusterType	string	No description.
createdAt	string	No description.
platformType	string	No description.
providerType	string	No description.
domainInput	string	No description.
enabledInput	boolean | cdktf.IResolvable	No description.
environmentScopeInput	string	No description.
idInput	string	No description.
kubernetesApiUrlInput	string	No description.
kubernetesAuthorizationTypeInput	string	No description.
kubernetesCaCertInput	string	No description.
kubernetesNamespaceInput	string	No description.
kubernetesTokenInput	string	No description.
managedInput	boolean | cdktf.IResolvable	No description.
managementProjectIdInput	string	No description.
nameInput	string	No description.
projectInput	string	No description.
domain	string	No description.
enabled	boolean | cdktf.IResolvable	No description.
environmentScope	string	No description.
id	string	No description.
kubernetesApiUrl	string	No description.
kubernetesAuthorizationType	string	No description.
kubernetesCaCert	string	No description.
kubernetesNamespace	string	No description.
kubernetesToken	string	No description.
managed	boolean | cdktf.IResolvable	No description.
managementProjectId	string	No description.
name	string	No description.
project	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

clusterType^Required

public readonly clusterType: string;

• Type: string

---

createdAt^Required

public readonly createdAt: string;

• Type: string

---

platformType^Required

public readonly platformType: string;

• Type: string

---

providerType^Required

public readonly providerType: string;

• Type: string

---

domainInput^Optional

public readonly domainInput: string;

• Type: string

---

enabledInput^Optional

public readonly enabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

environmentScopeInput^Optional

public readonly environmentScopeInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

kubernetesApiUrlInput^Optional

public readonly kubernetesApiUrlInput: string;

• Type: string

---

kubernetesAuthorizationTypeInput^Optional

public readonly kubernetesAuthorizationTypeInput: string;

• Type: string

---

kubernetesCaCertInput^Optional

public readonly kubernetesCaCertInput: string;

• Type: string

---

kubernetesNamespaceInput^Optional

public readonly kubernetesNamespaceInput: string;

• Type: string

---

kubernetesTokenInput^Optional

public readonly kubernetesTokenInput: string;

• Type: string

---

managedInput^Optional

public readonly managedInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

managementProjectIdInput^Optional

public readonly managementProjectIdInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

domain^Required

public readonly domain: string;

• Type: string

---

enabled^Required

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

environmentScope^Required

public readonly environmentScope: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

kubernetesApiUrl^Required

public readonly kubernetesApiUrl: string;

• Type: string

---

kubernetesAuthorizationType^Required

public readonly kubernetesAuthorizationType: string;

• Type: string

---

kubernetesCaCert^Required

public readonly kubernetesCaCert: string;

• Type: string

---

kubernetesNamespace^Required

public readonly kubernetesNamespace: string;

• Type: string

---

kubernetesToken^Required

public readonly kubernetesToken: string;

• Type: string

---

managed^Required

public readonly managed: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

managementProjectId^Required

public readonly managementProjectId: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ProjectClusterConfig

Initializer

import { projectCluster } from '@cdktf/provider-gitlab'

const projectClusterConfig: projectCluster.ProjectClusterConfig = { ... }

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.
kubernetesApiUrl	string	The URL to access the Kubernetes API.
kubernetesToken	string	The token to authenticate against Kubernetes.
name	string	The name of cluster.
project	string	The id of the project to add the cluster to.
domain	string	The base domain of the cluster.
enabled	boolean | cdktf.IResolvable	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.0.1/docs/resources/project_cluster#id ProjectCluster#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).
kubernetesNamespace	string	The unique namespace related to the project.
managed	boolean | cdktf.IResolvable	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 readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

kubernetesApiUrl^Required

public readonly kubernetesApiUrl: string;

• Type: string

The URL to access the Kubernetes API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#kubernetes_api_url ProjectCluster#kubernetes_api_url}

---

kubernetesToken^Required

public readonly kubernetesToken: string;

• Type: string

The token to authenticate against Kubernetes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#kubernetes_token ProjectCluster#kubernetes_token}

---

name^Required

public readonly name: string;

• Type: string

The name of cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#name ProjectCluster#name}

---

project^Required

public readonly project: string;

• Type: string

The id of the project to add the cluster to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#project ProjectCluster#project}

---

domain^Optional

public readonly domain: string;

• Type: string

The base domain of the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#domain ProjectCluster#domain}

---

enabled^Optional

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

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.0.1/docs/resources/project_cluster#enabled ProjectCluster#enabled}

---

environmentScope^Optional

public readonly environmentScope: string;

• Type: string

The associated environment to the cluster. Defaults to *.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#environment_scope ProjectCluster#environment_scope}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#id ProjectCluster#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 readonly kubernetesAuthorizationType: string;

• 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.0.1/docs/resources/project_cluster#kubernetes_authorization_type ProjectCluster#kubernetes_authorization_type}

---

kubernetesCaCert^Optional

public readonly kubernetesCaCert: string;

• 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.0.1/docs/resources/project_cluster#kubernetes_ca_cert ProjectCluster#kubernetes_ca_cert}

---

kubernetesNamespace^Optional

public readonly kubernetesNamespace: string;

• Type: string

The unique namespace related to the project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#kubernetes_namespace ProjectCluster#kubernetes_namespace}

---

managed^Optional

public readonly managed: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

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.0.1/docs/resources/project_cluster#managed ProjectCluster#managed}

---

managementProjectId^Optional

public readonly managementProjectId: string;

• Type: string

The ID of the management project for the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_cluster#management_project_id ProjectCluster#management_project_id}

---