UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
upcloud.getKubernetesCluster
Explore with Pulumi AI
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  # Use Kubernetes provider to access your Kubernetes cluster
  # Create a network for the Kubernetes cluster
  exampleNetwork:
    type: upcloud:Network
    name: example
    properties:
      name: example-network
      zone: de-fra1
      ipNetwork:
        address: 172.16.1.0/24
        dhcp: true
        family: IPv4
  # Create a Kubernetes cluster
  exampleKubernetesCluster:
    type: upcloud:KubernetesCluster
    name: example
    properties:
      name: exampleapp
      network: ${exampleNetwork.id}
      zone: de-fra1
      nodeGroup:
        - count: 2
          name: group1
          plan: K8S-2xCPU-4GB
          sshKeys:
            - public_ssh_key
          labels:
            managedBy: terraform
          taint:
            - effect: NoExecute
              key: taintKey
              value: taintValue
        - count: 2
          name: group2
          plan: K8S-2xCPU-4GB
  # Use the Kubernetes provider resources to interact with the cluster
  exampleNamespace:
    type: kubernetes:Namespace
    name: example
    properties:
      metadata:
        - name: example-namespace
  # In addition, write the kubeconfig to a file to interact with the cluster with `kubectl` or other clients
  exampleFile:
    type: local:File
    name: example
    properties:
      content: ${example.kubeconfig}
      filename: example.conf
variables:
  # Read the details of the newly created cluster
  example:
    fn::invoke:
      function: upcloud:getKubernetesCluster
      arguments:
        id: ${exampleKubernetesCluster.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(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetKubernetesClusterResult
def get_kubernetes_cluster_output(id: 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: upcloud:index/getKubernetesCluster:getKubernetesCluster
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Id string
- Id string
- id String
- id string
- id str
- id String
getKubernetesCluster Result
The following output properties are available:
- ClientCertificate string
- ClientKey string
- ClusterCa stringCertificate 
- Host string
- Id string
- Kubeconfig string
- Name string
- ClientCertificate string
- ClientKey string
- ClusterCa stringCertificate 
- Host string
- Id string
- Kubeconfig string
- Name string
- clientCertificate String
- clientKey String
- clusterCa StringCertificate 
- host String
- id String
- kubeconfig String
- name String
- clientCertificate string
- clientKey string
- clusterCa stringCertificate 
- host string
- id string
- kubeconfig string
- name string
- client_certificate str
- client_key str
- cluster_ca_ strcertificate 
- host str
- id str
- kubeconfig str
- name str
- clientCertificate String
- clientKey String
- clusterCa StringCertificate 
- host String
- id String
- kubeconfig String
- name String
Package Details
- Repository
- upcloud UpCloudLtd/pulumi-upcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the upcloudTerraform Provider.
