Skip to content

Latest commit

 

History

History
1577 lines (1001 loc) · 65.4 KB

instanceCluster.python.md

File metadata and controls

1577 lines (1001 loc) · 65.4 KB
Raw

instanceCluster Submodule

Constructs

InstanceCluster

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

Initializers 

from cdktf_cdktf_provider_gitlab import instance_cluster

instanceCluster.InstanceCluster(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  kubernetes_api_url: str,
  kubernetes_token: str,
  name: str,
  domain: str = None,
  enabled: typing.Union[bool, IResolvable] = None,
  environment_scope: str = None,
  id: str = None,
  kubernetes_authorization_type: str = None,
  kubernetes_ca_cert: str = None,
  kubernetes_namespace: str = None,
  managed: typing.Union[bool, IResolvable] = None,
  management_project_id: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
kubernetes_api_url str The URL to access the Kubernetes API.
kubernetes_token str The token to authenticate against Kubernetes. This attribute cannot be read.
name str The name of cluster.
domain str The base domain of the cluster.
enabled typing.Union[bool, cdktf.IResolvable] Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environment_scope str The associated environment to the cluster. Defaults to *.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#id InstanceCluster#id}.
kubernetes_authorization_type str The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetes_ca_cert str TLS certificate (needed if API is using a self-signed TLS certificate).
kubernetes_namespace str The unique namespace related to the instance.
managed typing.Union[bool, cdktf.IResolvable] Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
management_project_id str The ID of the management project for the cluster.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
kubernetes_api_urlRequired
  • Type: str

The URL to access the Kubernetes API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#kubernetes_api_url InstanceCluster#kubernetes_api_url}

kubernetes_tokenRequired
  • Type: str

The token to authenticate against Kubernetes. This attribute cannot be read.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#kubernetes_token InstanceCluster#kubernetes_token}

nameRequired
  • Type: str

The name of cluster.

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

domainOptional
  • Type: str

The base domain of the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#domain InstanceCluster#domain}

enabledOptional
  • Type: typing.Union[bool, 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.6.1/docs/resources/instance_cluster#enabled InstanceCluster#enabled}

environment_scopeOptional
  • Type: str

The associated environment to the cluster. Defaults to *.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#environment_scope InstanceCluster#environment_scope}

idOptional
  • Type: str

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

kubernetes_authorization_typeOptional
  • Type: str

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.6.1/docs/resources/instance_cluster#kubernetes_authorization_type InstanceCluster#kubernetes_authorization_type}

kubernetes_ca_certOptional
  • Type: str

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.6.1/docs/resources/instance_cluster#kubernetes_ca_cert InstanceCluster#kubernetes_ca_cert}

kubernetes_namespaceOptional
  • Type: str

The unique namespace related to the instance.

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

managedOptional
  • Type: typing.Union[bool, 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.6.1/docs/resources/instance_cluster#managed InstanceCluster#managed}

management_project_idOptional
  • Type: str

The ID of the management project for the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#management_project_id InstanceCluster#management_project_id}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_domain No description.
reset_enabled No description.
reset_environment_scope No description.
reset_id No description.
reset_kubernetes_authorization_type No description.
reset_kubernetes_ca_cert No description.
reset_kubernetes_namespace No description.
reset_managed No description.
reset_management_project_id No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

reset_domain 
def reset_domain() -> None
reset_enabled 
def reset_enabled() -> None
reset_environment_scope 
def reset_environment_scope() -> None
reset_id 
def reset_id() -> None
reset_kubernetes_authorization_type 
def reset_kubernetes_authorization_type() -> None
reset_kubernetes_ca_cert 
def reset_kubernetes_ca_cert() -> None
reset_kubernetes_namespace 
def reset_kubernetes_namespace() -> None
reset_managed 
def reset_managed() -> None
reset_management_project_id 
def reset_management_project_id() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a InstanceCluster resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_gitlab import instance_cluster

instanceCluster.InstanceCluster.is_construct(
  x: typing.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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_gitlab import instance_cluster

instanceCluster.InstanceCluster.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_gitlab import instance_cluster

instanceCluster.InstanceCluster.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_gitlab import instance_cluster

instanceCluster.InstanceCluster.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing InstanceCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#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 InstanceCluster to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
cluster_type str No description.
created_at str No description.
platform_type str No description.
provider_type str No description.
domain_input str No description.
enabled_input typing.Union[bool, cdktf.IResolvable] No description.
environment_scope_input str No description.
id_input str No description.
kubernetes_api_url_input str No description.
kubernetes_authorization_type_input str No description.
kubernetes_ca_cert_input str No description.
kubernetes_namespace_input str No description.
kubernetes_token_input str No description.
managed_input typing.Union[bool, cdktf.IResolvable] No description.
management_project_id_input str No description.
name_input str No description.
domain str No description.
enabled typing.Union[bool, cdktf.IResolvable] No description.
environment_scope str No description.
id str No description.
kubernetes_api_url str No description.
kubernetes_authorization_type str No description.
kubernetes_ca_cert str No description.
kubernetes_namespace str No description.
kubernetes_token str No description.
managed typing.Union[bool, cdktf.IResolvable] No description.
management_project_id str No description.
name str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
cluster_typeRequired 
cluster_type: str
  • Type: str
created_atRequired 
created_at: str
  • Type: str
platform_typeRequired 
platform_type: str
  • Type: str
provider_typeRequired 
provider_type: str
  • Type: str
domain_inputOptional 
domain_input: str
  • Type: str
enabled_inputOptional 
enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
environment_scope_inputOptional 
environment_scope_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
kubernetes_api_url_inputOptional 
kubernetes_api_url_input: str
  • Type: str
kubernetes_authorization_type_inputOptional 
kubernetes_authorization_type_input: str
  • Type: str
kubernetes_ca_cert_inputOptional 
kubernetes_ca_cert_input: str
  • Type: str
kubernetes_namespace_inputOptional 
kubernetes_namespace_input: str
  • Type: str
kubernetes_token_inputOptional 
kubernetes_token_input: str
  • Type: str
managed_inputOptional 
managed_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
management_project_id_inputOptional 
management_project_id_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
domainRequired 
domain: str
  • Type: str
enabledRequired 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
environment_scopeRequired 
environment_scope: str
  • Type: str
idRequired 
id: str
  • Type: str
kubernetes_api_urlRequired 
kubernetes_api_url: str
  • Type: str
kubernetes_authorization_typeRequired 
kubernetes_authorization_type: str
  • Type: str
kubernetes_ca_certRequired 
kubernetes_ca_cert: str
  • Type: str
kubernetes_namespaceRequired 
kubernetes_namespace: str
  • Type: str
kubernetes_tokenRequired 
kubernetes_token: str
  • Type: str
managedRequired 
managed: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
management_project_idRequired 
management_project_id: str
  • Type: str
nameRequired 
name: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

InstanceClusterConfig

Initializer 

from cdktf_cdktf_provider_gitlab import instance_cluster

instanceCluster.InstanceClusterConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  kubernetes_api_url: str,
  kubernetes_token: str,
  name: str,
  domain: str = None,
  enabled: typing.Union[bool, IResolvable] = None,
  environment_scope: str = None,
  id: str = None,
  kubernetes_authorization_type: str = None,
  kubernetes_ca_cert: str = None,
  kubernetes_namespace: str = None,
  managed: typing.Union[bool, IResolvable] = None,
  management_project_id: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
kubernetes_api_url str The URL to access the Kubernetes API.
kubernetes_token str The token to authenticate against Kubernetes. This attribute cannot be read.
name str The name of cluster.
domain str The base domain of the cluster.
enabled typing.Union[bool, cdktf.IResolvable] Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environment_scope str The associated environment to the cluster. Defaults to *.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#id InstanceCluster#id}.
kubernetes_authorization_type str The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetes_ca_cert str TLS certificate (needed if API is using a self-signed TLS certificate).
kubernetes_namespace str The unique namespace related to the instance.
managed typing.Union[bool, cdktf.IResolvable] Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
management_project_id str The ID of the management project for the cluster.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
kubernetes_api_urlRequired 
kubernetes_api_url: str
  • Type: str

The URL to access the Kubernetes API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#kubernetes_api_url InstanceCluster#kubernetes_api_url}

kubernetes_tokenRequired 
kubernetes_token: str
  • Type: str

The token to authenticate against Kubernetes. This attribute cannot be read.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#kubernetes_token InstanceCluster#kubernetes_token}

nameRequired 
name: str
  • Type: str

The name of cluster.

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

domainOptional 
domain: str
  • Type: str

The base domain of the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#domain InstanceCluster#domain}

enabledOptional 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.6.1/docs/resources/instance_cluster#enabled InstanceCluster#enabled}

environment_scopeOptional 
environment_scope: str
  • Type: str

The associated environment to the cluster. Defaults to *.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#environment_scope InstanceCluster#environment_scope}

idOptional 
id: str
  • Type: str

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

kubernetes_authorization_typeOptional 
kubernetes_authorization_type: str
  • Type: str

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.6.1/docs/resources/instance_cluster#kubernetes_authorization_type InstanceCluster#kubernetes_authorization_type}

kubernetes_ca_certOptional 
kubernetes_ca_cert: str
  • Type: str

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.6.1/docs/resources/instance_cluster#kubernetes_ca_cert InstanceCluster#kubernetes_ca_cert}

kubernetes_namespaceOptional 
kubernetes_namespace: str
  • Type: str

The unique namespace related to the instance.

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

managedOptional 
managed: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.6.1/docs/resources/instance_cluster#managed InstanceCluster#managed}

management_project_idOptional 
management_project_id: str
  • Type: str

The ID of the management project for the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#management_project_id InstanceCluster#management_project_id}