1. Packages
  2. Civo Provider
  3. API Docs
  4. getKubernetesCluster
Viewing docs for civo 1.1.7
published on Sunday, Sep 14, 2025 by civo
Schema (JSON)
civo/terraform-provider-civo

civo.getKubernetesCluster

civo logo
Viewing docs for civo 1.1.7
published on Sunday, Sep 14, 2025 by civo
Schema (JSON)
civo/terraform-provider-civo

    Provides a Civo Kubernetes cluster data source.

    Note: This data source returns a single Kubernetes cluster. When specifying a name, an error will be raised if more than one Kubernetes cluster found.

    Example Usage

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

const my_cluster = civo.getKubernetesCluster({
    name: "my-super-cluster",
});
export const kubernetesClusterOutput = my_cluster.then(my_cluster => my_cluster.masterIp);

    import pulumi
import pulumi_civo as civo

my_cluster = civo.get_kubernetes_cluster(name="my-super-cluster")
pulumi.export("kubernetesClusterOutput", my_cluster.master_ip)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		my_cluster, err := civo.LookupKubernetesCluster(ctx, &civo.LookupKubernetesClusterArgs{
			Name: pulumi.StringRef("my-super-cluster"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("kubernetesClusterOutput", my_cluster.MasterIp)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var my_cluster = Civo.GetKubernetesCluster.Invoke(new()
    {
        Name = "my-super-cluster",
    });

    return new Dictionary<string, object?>
    {
        ["kubernetesClusterOutput"] = my_cluster.Apply(my_cluster => my_cluster.Apply(getKubernetesClusterResult => getKubernetesClusterResult.MasterIp)),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.civo.CivoFunctions;
import com.pulumi.civo.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 my-cluster = CivoFunctions.getKubernetesCluster(GetKubernetesClusterArgs.builder()
            .name("my-super-cluster")
            .build());

        ctx.export("kubernetesClusterOutput", my_cluster.masterIp());
    }
}

    variables:
  my-cluster:
    fn::invoke:
      function: civo:getKubernetesCluster
      arguments:
        name: my-super-cluster
outputs:
  kubernetesClusterOutput: ${["my-cluster"].masterIp}

    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(id: Optional[str] = None,
                           name: Optional[str] = None,
                           region: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetKubernetesClusterResult
def get_kubernetes_cluster_output(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: civo:index/getKubernetesCluster:getKubernetesCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Name string
    The name of the Kubernetes Cluster
    Region string
    The region where cluster is running
    Id string
    The ID of this resource.
    Name string
    The name of the Kubernetes Cluster
    Region string
    The region where cluster is running
    id String
    The ID of this resource.
    name String
    The name of the Kubernetes Cluster
    region String
    The region where cluster is running
    id string
    The ID of this resource.
    name string
    The name of the Kubernetes Cluster
    region string
    The region where cluster is running
    id str
    The ID of this resource.
    name str
    The name of the Kubernetes Cluster
    region str
    The region where cluster is running
    id String
    The ID of this resource.
    name String
    The name of the Kubernetes Cluster
    region String
    The region where cluster is running

    getKubernetesCluster Result

    The following output properties are available:

    ApiEndpoint string
    The base URL of the API server on the Kubernetes master node
    Applications string
    A list of application installed
    Cni string
    The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
    CreatedAt string
    The date where the Kubernetes cluster was create
    DnsEntry string
    The unique dns entry for the cluster in this case point to the master
    InstalledApplications List<GetKubernetesClusterInstalledApplication>
    Kubeconfig string
    A representation of the Kubernetes cluster's kubeconfig in yaml format
    KubernetesVersion string
    The version of Kubernetes
    MasterIp string
    The IP of the Kubernetes master node
    NumTargetNodes double
    The size of the Kubernetes cluster

    Deprecated: Deprecated

    Pools List<GetKubernetesClusterPool>
    Ready bool
    If the Kubernetes cluster is ready
    Status string
    The status of Kubernetes cluster
    Tags List<string>
    A list of tags
    TargetNodesSize string
    The size of each node

    Deprecated: Deprecated

    VolumeType string
    Id string
    The ID of this resource.
    Name string
    The name of the Kubernetes Cluster
    Region string
    The region where cluster is running
    ApiEndpoint string
    The base URL of the API server on the Kubernetes master node
    Applications string
    A list of application installed
    Cni string
    The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
    CreatedAt string
    The date where the Kubernetes cluster was create
    DnsEntry string
    The unique dns entry for the cluster in this case point to the master
    InstalledApplications []GetKubernetesClusterInstalledApplication
    Kubeconfig string
    A representation of the Kubernetes cluster's kubeconfig in yaml format
    KubernetesVersion string
    The version of Kubernetes
    MasterIp string
    The IP of the Kubernetes master node
    NumTargetNodes float64
    The size of the Kubernetes cluster

    Deprecated: Deprecated

    Pools []GetKubernetesClusterPool
    Ready bool
    If the Kubernetes cluster is ready
    Status string
    The status of Kubernetes cluster
    Tags []string
    A list of tags
    TargetNodesSize string
    The size of each node

    Deprecated: Deprecated

    VolumeType string
    Id string
    The ID of this resource.
    Name string
    The name of the Kubernetes Cluster
    Region string
    The region where cluster is running
    apiEndpoint String
    The base URL of the API server on the Kubernetes master node
    applications String
    A list of application installed
    cni String
    The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
    createdAt String
    The date where the Kubernetes cluster was create
    dnsEntry String
    The unique dns entry for the cluster in this case point to the master
    installedApplications List<GetKubernetesClusterInstalledApplication>
    kubeconfig String
    A representation of the Kubernetes cluster's kubeconfig in yaml format
    kubernetesVersion String
    The version of Kubernetes
    masterIp String
    The IP of the Kubernetes master node
    numTargetNodes Double
    The size of the Kubernetes cluster

    Deprecated: Deprecated

    pools List<GetKubernetesClusterPool>
    ready Boolean
    If the Kubernetes cluster is ready
    status String
    The status of Kubernetes cluster
    tags List<String>
    A list of tags
    targetNodesSize String
    The size of each node

    Deprecated: Deprecated

    volumeType String
    id String
    The ID of this resource.
    name String
    The name of the Kubernetes Cluster
    region String
    The region where cluster is running
    apiEndpoint string
    The base URL of the API server on the Kubernetes master node
    applications string
    A list of application installed
    cni string
    The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
    createdAt string
    The date where the Kubernetes cluster was create
    dnsEntry string
    The unique dns entry for the cluster in this case point to the master
    installedApplications GetKubernetesClusterInstalledApplication[]
    kubeconfig string
    A representation of the Kubernetes cluster's kubeconfig in yaml format
    kubernetesVersion string
    The version of Kubernetes
    masterIp string
    The IP of the Kubernetes master node
    numTargetNodes number
    The size of the Kubernetes cluster

    Deprecated: Deprecated

    pools GetKubernetesClusterPool[]
    ready boolean
    If the Kubernetes cluster is ready
    status string
    The status of Kubernetes cluster
    tags string[]
    A list of tags
    targetNodesSize string
    The size of each node

    Deprecated: Deprecated

    volumeType string
    id string
    The ID of this resource.
    name string
    The name of the Kubernetes Cluster
    region string
    The region where cluster is running
    api_endpoint str
    The base URL of the API server on the Kubernetes master node
    applications str
    A list of application installed
    cni str
    The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
    created_at str
    The date where the Kubernetes cluster was create
    dns_entry str
    The unique dns entry for the cluster in this case point to the master
    installed_applications Sequence[GetKubernetesClusterInstalledApplication]
    kubeconfig str
    A representation of the Kubernetes cluster's kubeconfig in yaml format
    kubernetes_version str
    The version of Kubernetes
    master_ip str
    The IP of the Kubernetes master node
    num_target_nodes float
    The size of the Kubernetes cluster

    Deprecated: Deprecated

    pools Sequence[GetKubernetesClusterPool]
    ready bool
    If the Kubernetes cluster is ready
    status str
    The status of Kubernetes cluster
    tags Sequence[str]
    A list of tags
    target_nodes_size str
    The size of each node

    Deprecated: Deprecated

    volume_type str
    id str
    The ID of this resource.
    name str
    The name of the Kubernetes Cluster
    region str
    The region where cluster is running
    apiEndpoint String
    The base URL of the API server on the Kubernetes master node
    applications String
    A list of application installed
    cni String
    The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
    createdAt String
    The date where the Kubernetes cluster was create
    dnsEntry String
    The unique dns entry for the cluster in this case point to the master
    installedApplications List<Property Map>
    kubeconfig String
    A representation of the Kubernetes cluster's kubeconfig in yaml format
    kubernetesVersion String
    The version of Kubernetes
    masterIp String
    The IP of the Kubernetes master node
    numTargetNodes Number
    The size of the Kubernetes cluster

    Deprecated: Deprecated

    pools List<Property Map>
    ready Boolean
    If the Kubernetes cluster is ready
    status String
    The status of Kubernetes cluster
    tags List<String>
    A list of tags
    targetNodesSize String
    The size of each node

    Deprecated: Deprecated

    volumeType String
    id String
    The ID of this resource.
    name String
    The name of the Kubernetes Cluster
    region String
    The region where cluster is running

    Supporting Types

    GetKubernetesClusterInstalledApplication

    Application string
    Category string
    Installed bool
    Version string
    Application string
    Category string
    Installed bool
    Version string
    application String
    category String
    installed Boolean
    version String
    application string
    category string
    installed boolean
    version string
    application String
    category String
    installed Boolean
    version String

    GetKubernetesClusterPool

    InstanceNames List<string>
    Label string
    Labels Dictionary<string, string>
    NodeCount double
    PublicIpNodePool bool
    Size string
    Taints List<GetKubernetesClusterPoolTaint>
    instanceNames string[]
    label string
    labels {[key: string]: string}
    nodeCount number
    publicIpNodePool boolean
    size string
    taints GetKubernetesClusterPoolTaint[]
    instanceNames List<String>
    label String
    labels Map<String>
    nodeCount Number
    publicIpNodePool Boolean
    size String
    taints List<Property Map>

    GetKubernetesClusterPoolTaint

    Effect string
    Key string
    Value string
    Effect string
    Key string
    Value string
    effect String
    key String
    value String
    effect string
    key string
    value string
    effect str
    key str
    value str
    effect String
    key String
    value String

    Package Details

    Repository
    Civo civo/terraform-provider-civo
    License
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Viewing docs for civo 1.1.7
    published on Sunday, Sep 14, 2025 by civo
    Schema (JSON)
    civo/terraform-provider-civo
      Try Pulumi Cloud free. Your team will thank you.