vkcs.getKubernetesClusterV2

vkcs 0.15.0, May 5 26

Viewing docs for vkcs 0.15.0
published on Tuesday, May 5, 2026 by vk-cs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vkcs from "@pulumi/vkcs";

const k8sCluster = vkcs.getKubernetesClusterV2({
    id: k8sClusterVkcsKubernetesClusterV2.id,
});

import pulumi
import pulumi_vkcs as vkcs

k8s_cluster = vkcs.get_kubernetes_cluster_v2(id=k8s_cluster_vkcs_kubernetes_cluster_v2["id"])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.LookupKubernetesClusterV2(ctx, &vkcs.LookupKubernetesClusterV2Args{
			Id: k8sClusterVkcsKubernetesClusterV2.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var k8sCluster = Vkcs.GetKubernetesClusterV2.Invoke(new()
    {
        Id = k8sClusterVkcsKubernetesClusterV2.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.VkcsFunctions;
import com.pulumi.vkcs.inputs.GetKubernetesClusterV2Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var k8sCluster = VkcsFunctions.getKubernetesClusterV2(GetKubernetesClusterV2Args.builder()
            .id(k8sClusterVkcsKubernetesClusterV2.id())
            .build());

    }
}

variables:
  k8sCluster:
    fn::invoke:
      function: vkcs:getKubernetesClusterV2
      arguments:
        id: ${k8sClusterVkcsKubernetesClusterV2.id}

Using getKubernetesClusterV2

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKubernetesClusterV2(args: GetKubernetesClusterV2Args, opts?: InvokeOptions): Promise<GetKubernetesClusterV2Result>
function getKubernetesClusterV2Output(args: GetKubernetesClusterV2OutputArgs, opts?: InvokeOptions): Output<GetKubernetesClusterV2Result>

def get_kubernetes_cluster_v2(id: Optional[str] = None,
                              region: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetKubernetesClusterV2Result
def get_kubernetes_cluster_v2_output(id: pulumi.Input[Optional[str]] = None,
                              region: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesClusterV2Result]

func LookupKubernetesClusterV2(ctx *Context, args *LookupKubernetesClusterV2Args, opts ...InvokeOption) (*LookupKubernetesClusterV2Result, error)
func LookupKubernetesClusterV2Output(ctx *Context, args *LookupKubernetesClusterV2OutputArgs, opts ...InvokeOption) LookupKubernetesClusterV2ResultOutput

> Note: This function is named LookupKubernetesClusterV2 in the Go SDK.

public static class GetKubernetesClusterV2 
{
    public static Task<GetKubernetesClusterV2Result> InvokeAsync(GetKubernetesClusterV2Args args, InvokeOptions? opts = null)
    public static Output<GetKubernetesClusterV2Result> Invoke(GetKubernetesClusterV2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKubernetesClusterV2Result> getKubernetesClusterV2(GetKubernetesClusterV2Args args, InvokeOptions options)
public static Output<GetKubernetesClusterV2Result> getKubernetesClusterV2(GetKubernetesClusterV2Args args, InvokeOptions options)

fn::invoke:
  function: vkcs:index/getKubernetesClusterV2:getKubernetesClusterV2
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: required string → The cluster's ID. Used to fetch a specific cluster.
Region string: optional string → The region in which the cluster resides. If omitted, the provider's configured region is used.

Id string: required string → The cluster's ID. Used to fetch a specific cluster.
Region string: optional string → The region in which the cluster resides. If omitted, the provider's configured region is used.

id String: required string → The cluster's ID. Used to fetch a specific cluster.
region String: optional string → The region in which the cluster resides. If omitted, the provider's configured region is used.

id string: required string → The cluster's ID. Used to fetch a specific cluster.
region string: optional string → The region in which the cluster resides. If omitted, the provider's configured region is used.

id str: required string → The cluster's ID. Used to fetch a specific cluster.
region str: optional string → The region in which the cluster resides. If omitted, the provider's configured region is used.

id String: required string → The cluster's ID. Used to fetch a specific cluster.
region String: optional string → The region in which the cluster resides. If omitted, the provider's configured region is used.

getKubernetesClusterV2 Result

The following output properties are available:

ApiAddress string: string → The full URL of the Kubernetes API server (e.g., https://api.example.com:6443).
ApiLbFip string: string → The floating IP address of the API load balancer (present only when public_ip is true).
ApiLbVip string: string → The internal virtual IP address of the API load balancer.
AvailabilityZones List<string>: set of string → The availability zones in which the master nodes reside.
ClusterType string: string → The cluster type: standard (single AZ) or regional (three AZs).
CreatedAt string: string → The timestamp when the cluster was created (ISO 8601 format).
Description string: string → A user-provided description of the cluster.
ExternalNetworkId string: string → The ID of the external network providing internet access to the cluster.
Id string: string → The unique identifier of the node group.
InsecureRegistries List<string>: set of string → A list of container registry addresses that can be accessed without certificate validation.
K8sConfig string: string → The raw kubeconfig file contents used to authenticate to the Kubernetes API.
Labels Dictionary<string, string>: map of string → Kubernetes labels applied to the entire cluster.
LoadbalancerAllowedCidrs List<string>: set of string → CIDR blocks permitted to access the cluster's API load balancer.
LoadbalancerSubnetId string: string → The ID of the subnet where LoadBalancer type services are provisioned.
MasterCount double: number → The number of master nodes (1, 3, or 5) ensuring etcd quorum.
MasterDisks List<GetKubernetesClusterV2MasterDisk>: set → Information about the disks attached to master nodes (root, etcd, etcd-events). Each object contains type (disk type) and size (GB).
MasterFlavor string: string → The flavor ID (VM type) used for master nodes.
Name string: string → The user-assigned name of the node group.
NetworkId string: string → The ID of the VPC network where the cluster is deployed.
NetworkPlugin string: string → The CNI network plugin in use (always calico).
NodeGroups List<GetKubernetesClusterV2NodeGroup>: set → A list of node groups associated with the cluster. Each object includes id, name, flavor, node_count, and availability_zone.
PodsIpv4Cidr string: string → The IPv4 CIDR block allocated for pod networking.
ProjectId string: string → The VK Cloud project ID owning the cluster.
PublicIp bool: boolean → Indicates whether a floating IP is assigned to the cluster's API endpoint.
Region string
Status string: string → The current operational status of the cluster (e.g., RUNNING, RECONCILING).
SubnetId string: string → The ID of the subnet used by the cluster's nodes.
Uuid string: string → The cluster's UUID.
Version string: string → The installed Kubernetes version (e.g., v1.34.2).

ApiAddress string: string → The full URL of the Kubernetes API server (e.g., https://api.example.com:6443).
ApiLbFip string: string → The floating IP address of the API load balancer (present only when public_ip is true).
ApiLbVip string: string → The internal virtual IP address of the API load balancer.
AvailabilityZones []string: set of string → The availability zones in which the master nodes reside.
ClusterType string: string → The cluster type: standard (single AZ) or regional (three AZs).
CreatedAt string: string → The timestamp when the cluster was created (ISO 8601 format).
Description string: string → A user-provided description of the cluster.
ExternalNetworkId string: string → The ID of the external network providing internet access to the cluster.
Id string: string → The unique identifier of the node group.
InsecureRegistries []string: set of string → A list of container registry addresses that can be accessed without certificate validation.
K8sConfig string: string → The raw kubeconfig file contents used to authenticate to the Kubernetes API.
Labels map[string]string: map of string → Kubernetes labels applied to the entire cluster.
LoadbalancerAllowedCidrs []string: set of string → CIDR blocks permitted to access the cluster's API load balancer.
LoadbalancerSubnetId string: string → The ID of the subnet where LoadBalancer type services are provisioned.
MasterCount float64: number → The number of master nodes (1, 3, or 5) ensuring etcd quorum.
MasterDisks []GetKubernetesClusterV2MasterDisk: set → Information about the disks attached to master nodes (root, etcd, etcd-events). Each object contains type (disk type) and size (GB).
MasterFlavor string: string → The flavor ID (VM type) used for master nodes.
Name string: string → The user-assigned name of the node group.
NetworkId string: string → The ID of the VPC network where the cluster is deployed.
NetworkPlugin string: string → The CNI network plugin in use (always calico).
NodeGroups []GetKubernetesClusterV2NodeGroup: set → A list of node groups associated with the cluster. Each object includes id, name, flavor, node_count, and availability_zone.
PodsIpv4Cidr string: string → The IPv4 CIDR block allocated for pod networking.
ProjectId string: string → The VK Cloud project ID owning the cluster.
PublicIp bool: boolean → Indicates whether a floating IP is assigned to the cluster's API endpoint.
Region string
Status string: string → The current operational status of the cluster (e.g., RUNNING, RECONCILING).
SubnetId string: string → The ID of the subnet used by the cluster's nodes.
Uuid string: string → The cluster's UUID.
Version string: string → The installed Kubernetes version (e.g., v1.34.2).

apiAddress String: string → The full URL of the Kubernetes API server (e.g., https://api.example.com:6443).
apiLbFip String: string → The floating IP address of the API load balancer (present only when public_ip is true).
apiLbVip String: string → The internal virtual IP address of the API load balancer.
availabilityZones List<String>: set of string → The availability zones in which the master nodes reside.
clusterType String: string → The cluster type: standard (single AZ) or regional (three AZs).
createdAt String: string → The timestamp when the cluster was created (ISO 8601 format).
description String: string → A user-provided description of the cluster.
externalNetworkId String: string → The ID of the external network providing internet access to the cluster.
id String: string → The unique identifier of the node group.
insecureRegistries List<String>: set of string → A list of container registry addresses that can be accessed without certificate validation.
k8sConfig String: string → The raw kubeconfig file contents used to authenticate to the Kubernetes API.
labels Map<String,String>: map of string → Kubernetes labels applied to the entire cluster.
loadbalancerAllowedCidrs List<String>: set of string → CIDR blocks permitted to access the cluster's API load balancer.
loadbalancerSubnetId String: string → The ID of the subnet where LoadBalancer type services are provisioned.
masterCount Double: number → The number of master nodes (1, 3, or 5) ensuring etcd quorum.
masterDisks List<GetKubernetesClusterV2MasterDisk>: set → Information about the disks attached to master nodes (root, etcd, etcd-events). Each object contains type (disk type) and size (GB).
masterFlavor String: string → The flavor ID (VM type) used for master nodes.
name String: string → The user-assigned name of the node group.
networkId String: string → The ID of the VPC network where the cluster is deployed.
networkPlugin String: string → The CNI network plugin in use (always calico).
nodeGroups List<GetKubernetesClusterV2NodeGroup>: set → A list of node groups associated with the cluster. Each object includes id, name, flavor, node_count, and availability_zone.
podsIpv4Cidr String: string → The IPv4 CIDR block allocated for pod networking.
projectId String: string → The VK Cloud project ID owning the cluster.
publicIp Boolean: boolean → Indicates whether a floating IP is assigned to the cluster's API endpoint.
region String
status String: string → The current operational status of the cluster (e.g., RUNNING, RECONCILING).
subnetId String: string → The ID of the subnet used by the cluster's nodes.
uuid String: string → The cluster's UUID.
version String: string → The installed Kubernetes version (e.g., v1.34.2).

apiAddress string: string → The full URL of the Kubernetes API server (e.g., https://api.example.com:6443).
apiLbFip string: string → The floating IP address of the API load balancer (present only when public_ip is true).
apiLbVip string: string → The internal virtual IP address of the API load balancer.
availabilityZones string[]: set of string → The availability zones in which the master nodes reside.
clusterType string: string → The cluster type: standard (single AZ) or regional (three AZs).
createdAt string: string → The timestamp when the cluster was created (ISO 8601 format).
description string: string → A user-provided description of the cluster.
externalNetworkId string: string → The ID of the external network providing internet access to the cluster.
id string: string → The unique identifier of the node group.
insecureRegistries string[]: set of string → A list of container registry addresses that can be accessed without certificate validation.
k8sConfig string: string → The raw kubeconfig file contents used to authenticate to the Kubernetes API.
labels {[key: string]: string}: map of string → Kubernetes labels applied to the entire cluster.
loadbalancerAllowedCidrs string[]: set of string → CIDR blocks permitted to access the cluster's API load balancer.
loadbalancerSubnetId string: string → The ID of the subnet where LoadBalancer type services are provisioned.
masterCount number: number → The number of master nodes (1, 3, or 5) ensuring etcd quorum.
masterDisks GetKubernetesClusterV2MasterDisk[]: set → Information about the disks attached to master nodes (root, etcd, etcd-events). Each object contains type (disk type) and size (GB).
masterFlavor string: string → The flavor ID (VM type) used for master nodes.
name string: string → The user-assigned name of the node group.
networkId string: string → The ID of the VPC network where the cluster is deployed.
networkPlugin string: string → The CNI network plugin in use (always calico).
nodeGroups GetKubernetesClusterV2NodeGroup[]: set → A list of node groups associated with the cluster. Each object includes id, name, flavor, node_count, and availability_zone.
podsIpv4Cidr string: string → The IPv4 CIDR block allocated for pod networking.
projectId string: string → The VK Cloud project ID owning the cluster.
publicIp boolean: boolean → Indicates whether a floating IP is assigned to the cluster's API endpoint.
region string
status string: string → The current operational status of the cluster (e.g., RUNNING, RECONCILING).
subnetId string: string → The ID of the subnet used by the cluster's nodes.
uuid string: string → The cluster's UUID.
version string: string → The installed Kubernetes version (e.g., v1.34.2).

api_address str: string → The full URL of the Kubernetes API server (e.g., https://api.example.com:6443).
api_lb_fip str: string → The floating IP address of the API load balancer (present only when public_ip is true).
api_lb_vip str: string → The internal virtual IP address of the API load balancer.
availability_zones Sequence[str]: set of string → The availability zones in which the master nodes reside.
cluster_type str: string → The cluster type: standard (single AZ) or regional (three AZs).
created_at str: string → The timestamp when the cluster was created (ISO 8601 format).
description str: string → A user-provided description of the cluster.
external_network_id str: string → The ID of the external network providing internet access to the cluster.
id str: string → The unique identifier of the node group.
insecure_registries Sequence[str]: set of string → A list of container registry addresses that can be accessed without certificate validation.
k8s_config str: string → The raw kubeconfig file contents used to authenticate to the Kubernetes API.
labels Mapping[str, str]: map of string → Kubernetes labels applied to the entire cluster.
loadbalancer_allowed_cidrs Sequence[str]: set of string → CIDR blocks permitted to access the cluster's API load balancer.
loadbalancer_subnet_id str: string → The ID of the subnet where LoadBalancer type services are provisioned.
master_count float: number → The number of master nodes (1, 3, or 5) ensuring etcd quorum.
master_disks Sequence[GetKubernetesClusterV2MasterDisk]: set → Information about the disks attached to master nodes (root, etcd, etcd-events). Each object contains type (disk type) and size (GB).
master_flavor str: string → The flavor ID (VM type) used for master nodes.
name str: string → The user-assigned name of the node group.
network_id str: string → The ID of the VPC network where the cluster is deployed.
network_plugin str: string → The CNI network plugin in use (always calico).
node_groups Sequence[GetKubernetesClusterV2NodeGroup]: set → A list of node groups associated with the cluster. Each object includes id, name, flavor, node_count, and availability_zone.
pods_ipv4_cidr str: string → The IPv4 CIDR block allocated for pod networking.
project_id str: string → The VK Cloud project ID owning the cluster.
public_ip bool: boolean → Indicates whether a floating IP is assigned to the cluster's API endpoint.
region str
status str: string → The current operational status of the cluster (e.g., RUNNING, RECONCILING).
subnet_id str: string → The ID of the subnet used by the cluster's nodes.
uuid str: string → The cluster's UUID.
version str: string → The installed Kubernetes version (e.g., v1.34.2).

apiAddress String: string → The full URL of the Kubernetes API server (e.g., https://api.example.com:6443).
apiLbFip String: string → The floating IP address of the API load balancer (present only when public_ip is true).
apiLbVip String: string → The internal virtual IP address of the API load balancer.
availabilityZones List<String>: set of string → The availability zones in which the master nodes reside.
clusterType String: string → The cluster type: standard (single AZ) or regional (three AZs).
createdAt String: string → The timestamp when the cluster was created (ISO 8601 format).
description String: string → A user-provided description of the cluster.
externalNetworkId String: string → The ID of the external network providing internet access to the cluster.
id String: string → The unique identifier of the node group.
insecureRegistries List<String>: set of string → A list of container registry addresses that can be accessed without certificate validation.
k8sConfig String: string → The raw kubeconfig file contents used to authenticate to the Kubernetes API.
labels Map<String>: map of string → Kubernetes labels applied to the entire cluster.
loadbalancerAllowedCidrs List<String>: set of string → CIDR blocks permitted to access the cluster's API load balancer.
loadbalancerSubnetId String: string → The ID of the subnet where LoadBalancer type services are provisioned.
masterCount Number: number → The number of master nodes (1, 3, or 5) ensuring etcd quorum.
masterDisks List<Property Map>: set → Information about the disks attached to master nodes (root, etcd, etcd-events). Each object contains type (disk type) and size (GB).
masterFlavor String: string → The flavor ID (VM type) used for master nodes.
name String: string → The user-assigned name of the node group.
networkId String: string → The ID of the VPC network where the cluster is deployed.
networkPlugin String: string → The CNI network plugin in use (always calico).
nodeGroups List<Property Map>: set → A list of node groups associated with the cluster. Each object includes id, name, flavor, node_count, and availability_zone.
podsIpv4Cidr String: string → The IPv4 CIDR block allocated for pod networking.
projectId String: string → The VK Cloud project ID owning the cluster.
publicIp Boolean: boolean → Indicates whether a floating IP is assigned to the cluster's API endpoint.
region String
status String: string → The current operational status of the cluster (e.g., RUNNING, RECONCILING).
subnetId String: string → The ID of the subnet used by the cluster's nodes.
uuid String: string → The cluster's UUID.
version String: string → The installed Kubernetes version (e.g., v1.34.2).

Supporting Types

GetKubernetesClusterV2MasterDisk

Size double: number → The allocated size of the disk in gigabytes (GB).
Type string: string → The storage volume type used for this disk (e.g., ceph-ssd, ceph-hdd). Corresponds to the available volume types in the region.

Size float64: number → The allocated size of the disk in gigabytes (GB).
Type string: string → The storage volume type used for this disk (e.g., ceph-ssd, ceph-hdd). Corresponds to the available volume types in the region.

size Double: number → The allocated size of the disk in gigabytes (GB).
type String: string → The storage volume type used for this disk (e.g., ceph-ssd, ceph-hdd). Corresponds to the available volume types in the region.

size number: number → The allocated size of the disk in gigabytes (GB).
type string: string → The storage volume type used for this disk (e.g., ceph-ssd, ceph-hdd). Corresponds to the available volume types in the region.

size float: number → The allocated size of the disk in gigabytes (GB).
type str: string → The storage volume type used for this disk (e.g., ceph-ssd, ceph-hdd). Corresponds to the available volume types in the region.

size Number: number → The allocated size of the disk in gigabytes (GB).
type String: string → The storage volume type used for this disk (e.g., ceph-ssd, ceph-hdd). Corresponds to the available volume types in the region.

GetKubernetesClusterV2NodeGroup

AvailabilityZone string: string → The availability zone where the nodes of this group are deployed.
Flavor string: string → The flavor ID (VM type) used for each worker node in this group.
Id string: required string → The cluster's ID. Used to fetch a specific cluster.
Name string: string → The user-assigned name of the node group.
NodeCount double: number → The current number of worker nodes in the group. This value reflects the actual node count, accounting for both manual scaling and autoscaling actions.

AvailabilityZone string: string → The availability zone where the nodes of this group are deployed.
Flavor string: string → The flavor ID (VM type) used for each worker node in this group.
Id string: required string → The cluster's ID. Used to fetch a specific cluster.
Name string: string → The user-assigned name of the node group.
NodeCount float64: number → The current number of worker nodes in the group. This value reflects the actual node count, accounting for both manual scaling and autoscaling actions.

availabilityZone String: string → The availability zone where the nodes of this group are deployed.
flavor String: string → The flavor ID (VM type) used for each worker node in this group.
id String: required string → The cluster's ID. Used to fetch a specific cluster.
name String: string → The user-assigned name of the node group.
nodeCount Double: number → The current number of worker nodes in the group. This value reflects the actual node count, accounting for both manual scaling and autoscaling actions.

availabilityZone string: string → The availability zone where the nodes of this group are deployed.
flavor string: string → The flavor ID (VM type) used for each worker node in this group.
id string: required string → The cluster's ID. Used to fetch a specific cluster.
name string: string → The user-assigned name of the node group.
nodeCount number: number → The current number of worker nodes in the group. This value reflects the actual node count, accounting for both manual scaling and autoscaling actions.

availability_zone str: string → The availability zone where the nodes of this group are deployed.
flavor str: string → The flavor ID (VM type) used for each worker node in this group.
id str: required string → The cluster's ID. Used to fetch a specific cluster.
name str: string → The user-assigned name of the node group.
node_count float: number → The current number of worker nodes in the group. This value reflects the actual node count, accounting for both manual scaling and autoscaling actions.

availabilityZone String: string → The availability zone where the nodes of this group are deployed.
flavor String: string → The flavor ID (VM type) used for each worker node in this group.
id String: required string → The cluster's ID. Used to fetch a specific cluster.
name String: string → The user-assigned name of the node group.
nodeCount Number: number → The current number of worker nodes in the group. This value reflects the actual node count, accounting for both manual scaling and autoscaling actions.

Package Details

Repository: vkcs vk-cs/terraform-provider-vkcs
License
Notes: This Pulumi package is based on the vkcs Terraform Provider.

Viewing docs for vkcs 0.15.0
published on Tuesday, May 5, 2026 by vk-cs

Schema (JSON)

vk-cs/terraform-provider-vkcs

vkcs.getKubernetesClusterV2

On this page

On this page

Example Usage

Using getKubernetesClusterV2

getKubernetesClusterV2 Result

Supporting Types

GetKubernetesClusterV2MasterDisk

GetKubernetesClusterV2NodeGroup

Package Details

On this page

On this page