Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vkcs Provider
  3. API Docs
  4. getKubernetesCluster
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

vkcs.getKubernetesCluster

Explore with Pulumi AI

vkcs logo
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

    Use this data source to get the ID of an available VKCS kubernetes cluster.

    Example Usage

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

const k8sCluster = vkcs.getKubernetesCluster({
    id: vkcs_kubernetes_cluster.k8s_cluster.id,
});

    import pulumi
import pulumi_vkcs as vkcs

k8s_cluster = vkcs.get_kubernetes_cluster(id=vkcs_kubernetes_cluster["k8s_cluster"]["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.LookupKubernetesCluster(ctx, &vkcs.LookupKubernetesClusterArgs{
			Id: pulumi.StringRef(vkcs_kubernetes_cluster.K8s_cluster.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.GetKubernetesCluster.Invoke(new()
    {
        Id = vkcs_kubernetes_cluster.K8s_cluster.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.GetKubernetesClusterArgs;
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.getKubernetesCluster(GetKubernetesClusterArgs.builder()
            .id(vkcs_kubernetes_cluster.k8s_cluster().id())
            .build());

    }
}

    variables:
  k8sCluster:
    fn::invoke:
      function: vkcs:getKubernetesCluster
      arguments:
        id: ${vkcs_kubernetes_cluster.k8s_cluster.id}

    Using getKubernetesCluster

    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 getKubernetesCluster(args: GetKubernetesClusterArgs, opts?: InvokeOptions): Promise<GetKubernetesClusterResult>
function getKubernetesClusterOutput(args: GetKubernetesClusterOutputArgs, opts?: InvokeOptions): Output<GetKubernetesClusterResult>
    def get_kubernetes_cluster(cluster_id: Optional[str] = None,
                           dns_domain: Optional[str] = None,
                           id: Optional[str] = None,
                           name: Optional[str] = None,
                           region: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetKubernetesClusterResult
def get_kubernetes_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                           dns_domain: Optional[pulumi.Input[str]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           region: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesClusterResult]
    func LookupKubernetesCluster(ctx *Context, args *LookupKubernetesClusterArgs, opts ...InvokeOption) (*LookupKubernetesClusterResult, error)
func LookupKubernetesClusterOutput(ctx *Context, args *LookupKubernetesClusterOutputArgs, opts ...InvokeOption) LookupKubernetesClusterResultOutput

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

    public static class GetKubernetesCluster 
{
    public static Task<GetKubernetesClusterResult> InvokeAsync(GetKubernetesClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesClusterResult> Invoke(GetKubernetesClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKubernetesClusterResult> getKubernetesCluster(GetKubernetesClusterArgs args, InvokeOptions options)
public static Output<GetKubernetesClusterResult> getKubernetesCluster(GetKubernetesClusterArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ClusterId string
    optional deprecated string → The UUID of the Kubernetes cluster template. Note: Only one of name or cluster_id must be specified. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    DnsDomain string
    optional string → Custom DNS cluster domain.
    Id string
    optional string → The UUID of the Kubernetes cluster template. Note: Only one of name or id must be specified.
    Name string
    optional string → The name of the cluster. Note: Only one of name or id must be specified.
    Region string
    optional string → The region in which to obtain the Container Infra client. If omitted, the region argument of the provider is used.
    ClusterId string
    optional deprecated string → The UUID of the Kubernetes cluster template. Note: Only one of name or cluster_id must be specified. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    DnsDomain string
    optional string → Custom DNS cluster domain.
    Id string
    optional string → The UUID of the Kubernetes cluster template. Note: Only one of name or id must be specified.
    Name string
    optional string → The name of the cluster. Note: Only one of name or id must be specified.
    Region string
    optional string → The region in which to obtain the Container Infra client. If omitted, the region argument of the provider is used.
    clusterId String
    optional deprecated string → The UUID of the Kubernetes cluster template. Note: Only one of name or cluster_id must be specified. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    dnsDomain String
    optional string → Custom DNS cluster domain.
    id String
    optional string → The UUID of the Kubernetes cluster template. Note: Only one of name or id must be specified.
    name String
    optional string → The name of the cluster. Note: Only one of name or id must be specified.
    region String
    optional string → The region in which to obtain the Container Infra client. If omitted, the region argument of the provider is used.
    clusterId string
    optional deprecated string → The UUID of the Kubernetes cluster template. Note: Only one of name or cluster_id must be specified. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    dnsDomain string
    optional string → Custom DNS cluster domain.
    id string
    optional string → The UUID of the Kubernetes cluster template. Note: Only one of name or id must be specified.
    name string
    optional string → The name of the cluster. Note: Only one of name or id must be specified.
    region string
    optional string → The region in which to obtain the Container Infra client. If omitted, the region argument of the provider is used.
    cluster_id str
    optional deprecated string → The UUID of the Kubernetes cluster template. Note: Only one of name or cluster_id must be specified. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    dns_domain str
    optional string → Custom DNS cluster domain.
    id str
    optional string → The UUID of the Kubernetes cluster template. Note: Only one of name or id must be specified.
    name str
    optional string → The name of the cluster. Note: Only one of name or id must be specified.
    region str
    optional string → The region in which to obtain the Container Infra client. If omitted, the region argument of the provider is used.
    clusterId String
    optional deprecated string → The UUID of the Kubernetes cluster template. Note: Only one of name or cluster_id must be specified. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    dnsDomain String
    optional string → Custom DNS cluster domain.
    id String
    optional string → The UUID of the Kubernetes cluster template. Note: Only one of name or id must be specified.
    name String
    optional string → The name of the cluster. Note: Only one of name or id must be specified.
    region String
    optional string → The region in which to obtain the Container Infra client. If omitted, the region argument of the provider is used.

    getKubernetesCluster Result

    The following output properties are available:

    ApiAddress string
    string → COE API address.
    ApiLbFip string
    string → API LoadBalancer fip.
    ApiLbVip string
    string → API LoadBalancer vip.
    AvailabilityZone string
    string → Availability zone of the cluster.
    AvailabilityZones List<string>
    set of string → Availability zones of the regional clusterNew since v0.8.3.
    ClusterId string

    Deprecated: Deprecated

    ClusterTemplateId string
    string → The UUID of the V1 Container Infra cluster template.
    ClusterType string
    string → Type of the kubernetes cluster, may be standard or regionalNew since v0.8.3.
    CreatedAt string
    string → The time at which cluster was created.
    DiscoveryUrl string
    string → The URL used for cluster node discovery.
    DnsDomain string
    FloatingIpEnabled bool
    boolean → Indicates whether floating ip is enabled for cluster.
    Id string
    IngressFloatingIp string
    string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

    Deprecated: Deprecated

    InsecureRegistries List<string>
    string → Addresses of registries from which you can download images without checking certificates.
    K8sConfig string
    string → Kubeconfig for cluster
    Keypair string
    string → The name of the Compute service SSH keypair. Deprecated This argument is deprecated, please do not use it.

    Deprecated: Deprecated

    Labels Dictionary<string, string>
    map of string → The list of key value pairs representing additional properties of the cluster.
    LoadbalancerSubnetId string
    string → The ID of load balancer's subnet.
    MasterAddresses List<string>
    string → IP addresses of the master node of the cluster.
    MasterCount double
    number → The number of master nodes for the cluster.
    MasterFlavor string
    string → The ID of the flavor for the master nodes.
    Name string
    NetworkId string
    string → UUID of the cluster's network.
    PodsNetworkCidr string
    string → Network cidr of k8s virtual network.
    ProjectId string
    string → The project of the cluster.
    Region string
    RegistryAuthPassword string
    string → Docker registry access password.
    StackId string
    string → UUID of the Orchestration service stack.
    Status string
    string → Current state of a cluster.
    SubnetId string
    string → UUID of the cluster's subnet.
    SyncSecurityPolicy bool
    boolean → Enables syncing of security policies of cluster.New since v0.7.0.
    UpdatedAt string
    string → The time at which cluster was created.
    UserId string
    string → The user of the cluster.
    ApiAddress string
    string → COE API address.
    ApiLbFip string
    string → API LoadBalancer fip.
    ApiLbVip string
    string → API LoadBalancer vip.
    AvailabilityZone string
    string → Availability zone of the cluster.
    AvailabilityZones []string
    set of string → Availability zones of the regional clusterNew since v0.8.3.
    ClusterId string

    Deprecated: Deprecated

    ClusterTemplateId string
    string → The UUID of the V1 Container Infra cluster template.
    ClusterType string
    string → Type of the kubernetes cluster, may be standard or regionalNew since v0.8.3.
    CreatedAt string
    string → The time at which cluster was created.
    DiscoveryUrl string
    string → The URL used for cluster node discovery.
    DnsDomain string
    FloatingIpEnabled bool
    boolean → Indicates whether floating ip is enabled for cluster.
    Id string
    IngressFloatingIp string
    string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

    Deprecated: Deprecated

    InsecureRegistries []string
    string → Addresses of registries from which you can download images without checking certificates.
    K8sConfig string
    string → Kubeconfig for cluster
    Keypair string
    string → The name of the Compute service SSH keypair. Deprecated This argument is deprecated, please do not use it.

    Deprecated: Deprecated

    Labels map[string]string
    map of string → The list of key value pairs representing additional properties of the cluster.
    LoadbalancerSubnetId string
    string → The ID of load balancer's subnet.
    MasterAddresses []string
    string → IP addresses of the master node of the cluster.
    MasterCount float64
    number → The number of master nodes for the cluster.
    MasterFlavor string
    string → The ID of the flavor for the master nodes.
    Name string
    NetworkId string
    string → UUID of the cluster's network.
    PodsNetworkCidr string
    string → Network cidr of k8s virtual network.
    ProjectId string
    string → The project of the cluster.
    Region string
    RegistryAuthPassword string
    string → Docker registry access password.
    StackId string
    string → UUID of the Orchestration service stack.
    Status string
    string → Current state of a cluster.
    SubnetId string
    string → UUID of the cluster's subnet.
    SyncSecurityPolicy bool
    boolean → Enables syncing of security policies of cluster.New since v0.7.0.
    UpdatedAt string
    string → The time at which cluster was created.
    UserId string
    string → The user of the cluster.
    apiAddress String
    string → COE API address.
    apiLbFip String
    string → API LoadBalancer fip.
    apiLbVip String
    string → API LoadBalancer vip.
    availabilityZone String
    string → Availability zone of the cluster.
    availabilityZones List<String>
    set of string → Availability zones of the regional clusterNew since v0.8.3.
    clusterId String

    Deprecated: Deprecated

    clusterTemplateId String
    string → The UUID of the V1 Container Infra cluster template.
    clusterType String
    string → Type of the kubernetes cluster, may be standard or regionalNew since v0.8.3.
    createdAt String
    string → The time at which cluster was created.
    discoveryUrl String
    string → The URL used for cluster node discovery.
    dnsDomain String
    floatingIpEnabled Boolean
    boolean → Indicates whether floating ip is enabled for cluster.
    id String
    ingressFloatingIp String
    string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

    Deprecated: Deprecated

    insecureRegistries List<String>
    string → Addresses of registries from which you can download images without checking certificates.
    k8sConfig String
    string → Kubeconfig for cluster
    keypair String
    string → The name of the Compute service SSH keypair. Deprecated This argument is deprecated, please do not use it.

    Deprecated: Deprecated

    labels Map<String,String>
    map of string → The list of key value pairs representing additional properties of the cluster.
    loadbalancerSubnetId String
    string → The ID of load balancer's subnet.
    masterAddresses List<String>
    string → IP addresses of the master node of the cluster.
    masterCount Double
    number → The number of master nodes for the cluster.
    masterFlavor String
    string → The ID of the flavor for the master nodes.
    name String
    networkId String
    string → UUID of the cluster's network.
    podsNetworkCidr String
    string → Network cidr of k8s virtual network.
    projectId String
    string → The project of the cluster.
    region String
    registryAuthPassword String
    string → Docker registry access password.
    stackId String
    string → UUID of the Orchestration service stack.
    status String
    string → Current state of a cluster.
    subnetId String
    string → UUID of the cluster's subnet.
    syncSecurityPolicy Boolean
    boolean → Enables syncing of security policies of cluster.New since v0.7.0.
    updatedAt String
    string → The time at which cluster was created.
    userId String
    string → The user of the cluster.
    apiAddress string
    string → COE API address.
    apiLbFip string
    string → API LoadBalancer fip.
    apiLbVip string
    string → API LoadBalancer vip.
    availabilityZone string
    string → Availability zone of the cluster.
    availabilityZones string[]
    set of string → Availability zones of the regional clusterNew since v0.8.3.
    clusterId string

    Deprecated: Deprecated

    clusterTemplateId string
    string → The UUID of the V1 Container Infra cluster template.
    clusterType string
    string → Type of the kubernetes cluster, may be standard or regionalNew since v0.8.3.
    createdAt string
    string → The time at which cluster was created.
    discoveryUrl string
    string → The URL used for cluster node discovery.
    dnsDomain string
    floatingIpEnabled boolean
    boolean → Indicates whether floating ip is enabled for cluster.
    id string
    ingressFloatingIp string
    string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

    Deprecated: Deprecated

    insecureRegistries string[]
    string → Addresses of registries from which you can download images without checking certificates.
    k8sConfig string
    string → Kubeconfig for cluster
    keypair string
    string → The name of the Compute service SSH keypair. Deprecated This argument is deprecated, please do not use it.

    Deprecated: Deprecated

    labels {[key: string]: string}
    map of string → The list of key value pairs representing additional properties of the cluster.
    loadbalancerSubnetId string
    string → The ID of load balancer's subnet.
    masterAddresses string[]
    string → IP addresses of the master node of the cluster.
    masterCount number
    number → The number of master nodes for the cluster.
    masterFlavor string
    string → The ID of the flavor for the master nodes.
    name string
    networkId string
    string → UUID of the cluster's network.
    podsNetworkCidr string
    string → Network cidr of k8s virtual network.
    projectId string
    string → The project of the cluster.
    region string
    registryAuthPassword string
    string → Docker registry access password.
    stackId string
    string → UUID of the Orchestration service stack.
    status string
    string → Current state of a cluster.
    subnetId string
    string → UUID of the cluster's subnet.
    syncSecurityPolicy boolean
    boolean → Enables syncing of security policies of cluster.New since v0.7.0.
    updatedAt string
    string → The time at which cluster was created.
    userId string
    string → The user of the cluster.
    api_address str
    string → COE API address.
    api_lb_fip str
    string → API LoadBalancer fip.
    api_lb_vip str
    string → API LoadBalancer vip.
    availability_zone str
    string → Availability zone of the cluster.
    availability_zones Sequence[str]
    set of string → Availability zones of the regional clusterNew since v0.8.3.
    cluster_id str

    Deprecated: Deprecated

    cluster_template_id str
    string → The UUID of the V1 Container Infra cluster template.
    cluster_type str
    string → Type of the kubernetes cluster, may be standard or regionalNew since v0.8.3.
    created_at str
    string → The time at which cluster was created.
    discovery_url str
    string → The URL used for cluster node discovery.
    dns_domain str
    floating_ip_enabled bool
    boolean → Indicates whether floating ip is enabled for cluster.
    id str
    ingress_floating_ip str
    string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

    Deprecated: Deprecated

    insecure_registries Sequence[str]
    string → Addresses of registries from which you can download images without checking certificates.
    k8s_config str
    string → Kubeconfig for cluster
    keypair str
    string → The name of the Compute service SSH keypair. Deprecated This argument is deprecated, please do not use it.

    Deprecated: Deprecated

    labels Mapping[str, str]
    map of string → The list of key value pairs representing additional properties of the cluster.
    loadbalancer_subnet_id str
    string → The ID of load balancer's subnet.
    master_addresses Sequence[str]
    string → IP addresses of the master node of the cluster.
    master_count float
    number → The number of master nodes for the cluster.
    master_flavor str
    string → The ID of the flavor for the master nodes.
    name str
    network_id str
    string → UUID of the cluster's network.
    pods_network_cidr str
    string → Network cidr of k8s virtual network.
    project_id str
    string → The project of the cluster.
    region str
    registry_auth_password str
    string → Docker registry access password.
    stack_id str
    string → UUID of the Orchestration service stack.
    status str
    string → Current state of a cluster.
    subnet_id str
    string → UUID of the cluster's subnet.
    sync_security_policy bool
    boolean → Enables syncing of security policies of cluster.New since v0.7.0.
    updated_at str
    string → The time at which cluster was created.
    user_id str
    string → The user of the cluster.
    apiAddress String
    string → COE API address.
    apiLbFip String
    string → API LoadBalancer fip.
    apiLbVip String
    string → API LoadBalancer vip.
    availabilityZone String
    string → Availability zone of the cluster.
    availabilityZones List<String>
    set of string → Availability zones of the regional clusterNew since v0.8.3.
    clusterId String

    Deprecated: Deprecated

    clusterTemplateId String
    string → The UUID of the V1 Container Infra cluster template.
    clusterType String
    string → Type of the kubernetes cluster, may be standard or regionalNew since v0.8.3.
    createdAt String
    string → The time at which cluster was created.
    discoveryUrl String
    string → The URL used for cluster node discovery.
    dnsDomain String
    floatingIpEnabled Boolean
    boolean → Indicates whether floating ip is enabled for cluster.
    id String
    ingressFloatingIp String
    string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

    Deprecated: Deprecated

    insecureRegistries List<String>
    string → Addresses of registries from which you can download images without checking certificates.
    k8sConfig String
    string → Kubeconfig for cluster
    keypair String
    string → The name of the Compute service SSH keypair. Deprecated This argument is deprecated, please do not use it.

    Deprecated: Deprecated

    labels Map<String>
    map of string → The list of key value pairs representing additional properties of the cluster.
    loadbalancerSubnetId String
    string → The ID of load balancer's subnet.
    masterAddresses List<String>
    string → IP addresses of the master node of the cluster.
    masterCount Number
    number → The number of master nodes for the cluster.
    masterFlavor String
    string → The ID of the flavor for the master nodes.
    name String
    networkId String
    string → UUID of the cluster's network.
    podsNetworkCidr String
    string → Network cidr of k8s virtual network.
    projectId String
    string → The project of the cluster.
    region String
    registryAuthPassword String
    string → Docker registry access password.
    stackId String
    string → UUID of the Orchestration service stack.
    status String
    string → Current state of a cluster.
    subnetId String
    string → UUID of the cluster's subnet.
    syncSecurityPolicy Boolean
    boolean → Enables syncing of security policies of cluster.New since v0.7.0.
    updatedAt String
    string → The time at which cluster was created.
    userId String
    string → The user of the cluster.

    Package Details

    Repository
    vkcs vk-cs/terraform-provider-vkcs
    License
    Notes
    This Pulumi package is based on the vkcs Terraform Provider.
    vkcs logo
    vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
    vk-cs/terraform-provider-vkcs