`kubernetesCluster` Submodule

Constructs

KubernetesCluster

Represents a {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster upcloud_kubernetes_cluster}.

Initializers

using HashiCorp.Cdktf.Providers.Upcloud;

new KubernetesCluster(Construct Scope, string Id, KubernetesClusterConfig Config);

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

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".
`ResetLabels`	No description.
`ResetPlan`	No description.
`ResetPrivateNodeGroups`	No description.
`ResetStorageEncryption`	No description.
`ResetVersion`	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".

`ResetLabels`

private void ResetLabels()

`ResetPlan`

private void ResetPlan()

`ResetPrivateNodeGroups`

private void ResetPrivateNodeGroups()

`ResetStorageEncryption`

private void ResetStorageEncryption()

`ResetVersion`

private void ResetVersion()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Upcloud;

KubernetesCluster.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.Upcloud;

KubernetesCluster.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Upcloud;

KubernetesCluster.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Upcloud;

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

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

`ImportFromId`^Required

Type: string

The id of the existing KubernetesCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_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 KubernetesCluster to import is found.

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`HashiCorp.Cdktf.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Id`	`string`	No description.
`NetworkCidr`	`string`	No description.
`NodeGroups`	`string[]`	No description.
`State`	`string`	No description.
`ControlPlaneIpFilterInput`	`string[]`	No description.
`LabelsInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`NameInput`	`string`	No description.
`NetworkInput`	`string`	No description.
`PlanInput`	`string`	No description.
`PrivateNodeGroupsInput`	`object`	No description.
`StorageEncryptionInput`	`string`	No description.
`VersionInput`	`string`	No description.
`ZoneInput`	`string`	No description.
`ControlPlaneIpFilter`	`string[]`	No description.
`Labels`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`Name`	`string`	No description.
`Network`	`string`	No description.
`Plan`	`string`	No description.
`PrivateNodeGroups`	`object`	No description.
`StorageEncryption`	`string`	No description.
`Version`	`string`	No description.
`Zone`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

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

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

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`Id`^Required

public string Id { get; }

Type: string

`NetworkCidr`^Required

public string NetworkCidr { get; }

Type: string

`NodeGroups`^Required

public string[] NodeGroups { get; }

Type: string[]

`State`^Required

public string State { get; }

Type: string

`ControlPlaneIpFilterInput`^Optional

public string[] ControlPlaneIpFilterInput { get; }

Type: string[]

`LabelsInput`^Optional

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

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

`NameInput`^Optional

public string NameInput { get; }

Type: string

`NetworkInput`^Optional

public string NetworkInput { get; }

Type: string

`PlanInput`^Optional

public string PlanInput { get; }

Type: string

`PrivateNodeGroupsInput`^Optional

public object PrivateNodeGroupsInput { get; }

Type: object

`StorageEncryptionInput`^Optional

public string StorageEncryptionInput { get; }

Type: string

`VersionInput`^Optional

public string VersionInput { get; }

Type: string

`ZoneInput`^Optional

public string ZoneInput { get; }

Type: string

`ControlPlaneIpFilter`^Required

public string[] ControlPlaneIpFilter { get; }

Type: string[]

`Labels`^Required

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

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

`Name`^Required

public string Name { get; }

Type: string

`Network`^Required

public string Network { get; }

Type: string

`Plan`^Required

public string Plan { get; }

Type: string

`PrivateNodeGroups`^Required

public object PrivateNodeGroups { get; }

Type: object

`StorageEncryption`^Required

public string StorageEncryption { get; }

Type: string

`Version`^Required

public string Version { get; }

Type: string

`Zone`^Required

public string Zone { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

KubernetesClusterConfig

Initializer

using HashiCorp.Cdktf.Providers.Upcloud;

new KubernetesClusterConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string[] ControlPlaneIpFilter,
    string Name,
    string Network,
    string Zone,
    System.Collections.Generic.IDictionary<string, string> Labels = null,
    string Plan = null,
    object PrivateNodeGroups = null,
    string StorageEncryption = null,
    string Version = 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.
`ControlPlaneIpFilter`	`string[]`	IP addresses or IP ranges in CIDR format which are allowed to access the cluster control plane.
`Name`	`string`	Cluster name. Needs to be unique within the account.
`Network`	`string`	Network ID for the cluster to run in.
`Zone`	`string`	Zone in which the Kubernetes cluster will be hosted, e.g. `de-fra1`. You can list available zones with `upctl zone list`.
`Labels`	`System.Collections.Generic.IDictionary<string, string>`	User defined key-value pairs to classify the cluster.
`Plan`	`string`	The pricing plan used for the cluster.
`PrivateNodeGroups`	`object`	Enable private node groups. Private node groups requires a network that is routed through NAT gateway.
`StorageEncryption`	`string`	Set default storage encryption strategy for all nodes in the cluster.
`Version`	`string`	Kubernetes version ID, e.g. `1.29`. You can list available version IDs with `upctl kubernetes versions`.

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

`ControlPlaneIpFilter`^Required

public string[] ControlPlaneIpFilter { get; set; }

Type: string[]

IP addresses or IP ranges in CIDR format which are allowed to access the cluster control plane.

To allow access from any source, use ["0.0.0.0/0"]. To deny access from all sources, use []. Values set here do not restrict access to node groups or exposed Kubernetes services.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster#control_plane_ip_filter KubernetesCluster#control_plane_ip_filter}

`Name`^Required

public string Name { get; set; }

Type: string

Cluster name. Needs to be unique within the account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster#name KubernetesCluster#name}

`Network`^Required

public string Network { get; set; }

Type: string

Network ID for the cluster to run in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster#network KubernetesCluster#network}

`Zone`^Required

public string Zone { get; set; }

Type: string

Zone in which the Kubernetes cluster will be hosted, e.g. de-fra1. You can list available zones with upctl zone list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster#zone KubernetesCluster#zone}

`Labels`^Optional

public System.Collections.Generic.IDictionary<string, string> Labels { get; set; }

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

User defined key-value pairs to classify the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster#labels KubernetesCluster#labels}

`Plan`^Optional

public string Plan { get; set; }

Type: string

The pricing plan used for the cluster.

Default plan is development. You can list available plans with upctl kubernetes plans.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster#plan KubernetesCluster#plan}

`PrivateNodeGroups`^Optional

public object PrivateNodeGroups { get; set; }

Type: object

Enable private node groups. Private node groups requires a network that is routed through NAT gateway.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster#private_node_groups KubernetesCluster#private_node_groups}

`StorageEncryption`^Optional

public string StorageEncryption { get; set; }

Type: string

Set default storage encryption strategy for all nodes in the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster#storage_encryption KubernetesCluster#storage_encryption}

`Version`^Optional

public string Version { get; set; }

Type: string

Kubernetes version ID, e.g. 1.29. You can list available version IDs with upctl kubernetes versions.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.17.0/docs/resources/kubernetes_cluster#version KubernetesCluster#version}

Files

kubernetesCluster.csharp.md

Latest commit

History

kubernetesCluster.csharp.md

File metadata and controls

kubernetesCluster Submodule

Constructs