IonosCloud v0.2.3, May 13 25

IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud

ionoscloud.k8s.getCluster

Explore with Pulumi AI

IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud

The k8s Cluster data source can be used to search for and return existing k8s clusters. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

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

const example = ionoscloud.k8s.getCluster({
    id: "cluster_id",
});

import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.k8s.get_cluster(id="cluster_id")

package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/k8s"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := k8s.LookupCluster(ctx, &k8s.LookupClusterArgs{
			Id: pulumi.StringRef("cluster_id"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Ionoscloud.K8s.GetCluster.Invoke(new()
    {
        Id = "cluster_id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.k8s.K8sFunctions;
import com.pulumi.ionoscloud.k8s.inputs.GetClusterArgs;
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 example = K8sFunctions.getCluster(GetClusterArgs.builder()
            .id("cluster_id")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: ionoscloud:k8s:getCluster
      arguments:
        id: cluster_id

By Name

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

const example = ionoscloud.k8s.getCluster({
    name: "K8s Cluster Example",
});

import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.k8s.get_cluster(name="K8s Cluster Example")

package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/k8s"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := k8s.LookupCluster(ctx, &k8s.LookupClusterArgs{
			Name: pulumi.StringRef("K8s Cluster Example"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Ionoscloud.K8s.GetCluster.Invoke(new()
    {
        Name = "K8s Cluster Example",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.k8s.K8sFunctions;
import com.pulumi.ionoscloud.k8s.inputs.GetClusterArgs;
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 example = K8sFunctions.getCluster(GetClusterArgs.builder()
            .name("K8s Cluster Example")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: ionoscloud:k8s:getCluster
      arguments:
        name: K8s Cluster Example

Example of accessing a kubernetes cluster using the user’s token

import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@ionos-cloud/sdk-pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";

const testCluster = new ionoscloud.k8s.Cluster("test", {
    name: "test_cluster",
    maintenanceWindow: {
        dayOfTheWeek: "Saturday",
        time: "03:58:25Z",
    },
});
const test = ionoscloud.k8s.getCluster({
    name: "test_cluster",
});

import pulumi
import pulumi_ionoscloud as ionoscloud

test_cluster = ionoscloud.k8s.Cluster("test",
    name="test_cluster",
    maintenance_window={
        "day_of_the_week": "Saturday",
        "time": "03:58:25Z",
    })
test = ionoscloud.k8s.get_cluster(name="test_cluster")

package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/k8s"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := k8s.NewCluster(ctx, "test", &k8s.ClusterArgs{
			Name: pulumi.String("test_cluster"),
			MaintenanceWindow: &k8s.ClusterMaintenanceWindowArgs{
				DayOfTheWeek: pulumi.String("Saturday"),
				Time:         pulumi.String("03:58:25Z"),
			},
		})
		if err != nil {
			return err
		}
		_, err = k8s.LookupCluster(ctx, &k8s.LookupClusterArgs{
			Name: pulumi.StringRef("test_cluster"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testCluster = new Ionoscloud.K8s.Cluster("test", new()
    {
        Name = "test_cluster",
        MaintenanceWindow = new Ionoscloud.K8s.Inputs.ClusterMaintenanceWindowArgs
        {
            DayOfTheWeek = "Saturday",
            Time = "03:58:25Z",
        },
    });

    var test = Ionoscloud.K8s.GetCluster.Invoke(new()
    {
        Name = "test_cluster",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.k8s.Cluster;
import com.pulumi.ionoscloud.k8s.ClusterArgs;
import com.pulumi.ionoscloud.k8s.inputs.ClusterMaintenanceWindowArgs;
import com.pulumi.ionoscloud.k8s.K8sFunctions;
import com.pulumi.ionoscloud.k8s.inputs.GetClusterArgs;
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) {
        var testCluster = new Cluster("testCluster", ClusterArgs.builder()
            .name("test_cluster")
            .maintenanceWindow(ClusterMaintenanceWindowArgs.builder()
                .dayOfTheWeek("Saturday")
                .time("03:58:25Z")
                .build())
            .build());

        final var test = K8sFunctions.getCluster(GetClusterArgs.builder()
            .name("test_cluster")
            .build());

    }
}

resources:
  testCluster:
    type: ionoscloud:k8s:Cluster
    name: test
    properties:
      name: test_cluster
      maintenanceWindow:
        dayOfTheWeek: Saturday
        time: 03:58:25Z
variables:
  test:
    fn::invoke:
      function: ionoscloud:k8s:getCluster
      arguments:
        name: test_cluster

Example of accessing a kubernetes cluster using the token from the config

import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@ionos-cloud/sdk-pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";

const testCluster = new ionoscloud.k8s.Cluster("test", {
    name: "test_cluster",
    maintenanceWindow: {
        dayOfTheWeek: "Saturday",
        time: "03:58:25Z",
    },
});
const test = ionoscloud.k8s.getCluster({
    name: "test_cluster",
});

import pulumi
import pulumi_ionoscloud as ionoscloud

test_cluster = ionoscloud.k8s.Cluster("test",
    name="test_cluster",
    maintenance_window={
        "day_of_the_week": "Saturday",
        "time": "03:58:25Z",
    })
test = ionoscloud.k8s.get_cluster(name="test_cluster")

package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/k8s"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := k8s.NewCluster(ctx, "test", &k8s.ClusterArgs{
			Name: pulumi.String("test_cluster"),
			MaintenanceWindow: &k8s.ClusterMaintenanceWindowArgs{
				DayOfTheWeek: pulumi.String("Saturday"),
				Time:         pulumi.String("03:58:25Z"),
			},
		})
		if err != nil {
			return err
		}
		_, err = k8s.LookupCluster(ctx, &k8s.LookupClusterArgs{
			Name: pulumi.StringRef("test_cluster"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testCluster = new Ionoscloud.K8s.Cluster("test", new()
    {
        Name = "test_cluster",
        MaintenanceWindow = new Ionoscloud.K8s.Inputs.ClusterMaintenanceWindowArgs
        {
            DayOfTheWeek = "Saturday",
            Time = "03:58:25Z",
        },
    });

    var test = Ionoscloud.K8s.GetCluster.Invoke(new()
    {
        Name = "test_cluster",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.k8s.Cluster;
import com.pulumi.ionoscloud.k8s.ClusterArgs;
import com.pulumi.ionoscloud.k8s.inputs.ClusterMaintenanceWindowArgs;
import com.pulumi.ionoscloud.k8s.K8sFunctions;
import com.pulumi.ionoscloud.k8s.inputs.GetClusterArgs;
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) {
        var testCluster = new Cluster("testCluster", ClusterArgs.builder()
            .name("test_cluster")
            .maintenanceWindow(ClusterMaintenanceWindowArgs.builder()
                .dayOfTheWeek("Saturday")
                .time("03:58:25Z")
                .build())
            .build());

        final var test = K8sFunctions.getCluster(GetClusterArgs.builder()
            .name("test_cluster")
            .build());

    }
}

resources:
  testCluster:
    type: ionoscloud:k8s:Cluster
    name: test
    properties:
      name: test_cluster
      maintenanceWindow:
        dayOfTheWeek: Saturday
        time: 03:58:25Z
variables:
  test:
    fn::invoke:
      function: ionoscloud:k8s:getCluster
      arguments:
        name: test_cluster

Using getCluster

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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>

def get_cluster(id: Optional[str] = None,
                name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]

func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

fn::invoke:
  function: ionoscloud:k8s/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string

ID of the cluster you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Name string

Name of an existing cluster that you want to search for.

Id string

ID of the cluster you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Name string

Name of an existing cluster that you want to search for.

id String

ID of the cluster you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

name String

Name of an existing cluster that you want to search for.

id string

ID of the cluster you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

name string

Name of an existing cluster that you want to search for.

id str

ID of the cluster you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

name str

Name of an existing cluster that you want to search for.

id String

ID of the cluster you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

name String

Name of an existing cluster that you want to search for.

getCluster Result

The following output properties are available:

ApiSubnetAllowLists List<string>

access to the K8s API server is restricted to these CIDRs

AvailableUpgradeVersions List<string>

A list of available versions for upgrading the cluster

CaCrt string

base64 decoded cluster certificate authority data (provided as an attribute for direct use)

Configs List<Ionoscloud.GetClusterConfig>

structured kubernetes config consisting of a list with 1 item with the following fields:

api_version - Kubernetes API Version
kind - "Config"
current-context - string
clusters - list of
name - name of cluster
cluster - map of
certificate-authority-data - base64 decoded cluster CA data
server - server address in the form https://host:port
contexts - list of
name - context name
context - map of
cluster - cluster name
user - cluster user
users - list of
name - user name
user - map of
token - user token used for authentication

Id string

id of the cluster

K8sVersion string

Kubernetes version

KubeConfig string

Kubernetes configuration

Location string

this attribute is mandatory if the cluster is private.

MaintenanceWindows List<Ionoscloud.GetClusterMaintenanceWindow>

A maintenance window comprise of a day of the week and a time for maintenance to be allowed

Name string

name of the cluster

NatGatewayIp string

the NAT gateway IP of the cluster if the cluster is private.

NodePools List<string>

list of the IDs of the node pools in this cluster

NodeSubnet string

the node subnet of the cluster, if the cluster is private.

Public bool

indicates if the cluster is public or private.

S3Buckets List<Ionoscloud.GetClusterS3Bucket>

list of IONOS Object Storage bucket configured for K8s usage

Server string

cluster server (same as config[0].clusters[0].cluster.server but provided as an attribute for ease of use)

State string

one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"

UserTokens Dictionary<string, string>

a convenience map to be search the token of a specific user

key - is the user name
value - is the token

ViableNodePoolVersions List<string>

A list of versions that may be used for node pools under this cluster

ApiSubnetAllowLists []string

access to the K8s API server is restricted to these CIDRs

AvailableUpgradeVersions []string

A list of available versions for upgrading the cluster

CaCrt string

base64 decoded cluster certificate authority data (provided as an attribute for direct use)

Configs []GetClusterConfig

structured kubernetes config consisting of a list with 1 item with the following fields:

api_version - Kubernetes API Version
kind - "Config"
current-context - string
clusters - list of
name - name of cluster
cluster - map of
certificate-authority-data - base64 decoded cluster CA data
server - server address in the form https://host:port
contexts - list of
name - context name
context - map of
cluster - cluster name
user - cluster user
users - list of
name - user name
user - map of
token - user token used for authentication

Id string

id of the cluster

K8sVersion string

Kubernetes version

KubeConfig string

Kubernetes configuration

Location string

this attribute is mandatory if the cluster is private.

MaintenanceWindows []GetClusterMaintenanceWindow

A maintenance window comprise of a day of the week and a time for maintenance to be allowed

Name string

name of the cluster

NatGatewayIp string

the NAT gateway IP of the cluster if the cluster is private.

NodePools []string

list of the IDs of the node pools in this cluster

NodeSubnet string

the node subnet of the cluster, if the cluster is private.

Public bool

indicates if the cluster is public or private.

S3Buckets []GetClusterS3Bucket

list of IONOS Object Storage bucket configured for K8s usage

Server string

cluster server (same as config[0].clusters[0].cluster.server but provided as an attribute for ease of use)

State string

one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"

UserTokens map[string]string

a convenience map to be search the token of a specific user

key - is the user name
value - is the token

ViableNodePoolVersions []string

A list of versions that may be used for node pools under this cluster

apiSubnetAllowLists List<String>

access to the K8s API server is restricted to these CIDRs

availableUpgradeVersions List<String>

A list of available versions for upgrading the cluster

caCrt String

base64 decoded cluster certificate authority data (provided as an attribute for direct use)

configs List<GetClusterConfig>

structured kubernetes config consisting of a list with 1 item with the following fields:

api_version - Kubernetes API Version
kind - "Config"
current-context - string
clusters - list of
name - name of cluster
cluster - map of
certificate-authority-data - base64 decoded cluster CA data
server - server address in the form https://host:port
contexts - list of
name - context name
context - map of
cluster - cluster name
user - cluster user
users - list of
name - user name
user - map of
token - user token used for authentication

id String

id of the cluster

k8sVersion String

Kubernetes version

kubeConfig String

Kubernetes configuration

location String

this attribute is mandatory if the cluster is private.

maintenanceWindows List<GetClusterMaintenanceWindow>

A maintenance window comprise of a day of the week and a time for maintenance to be allowed

name String

name of the cluster

natGatewayIp String

the NAT gateway IP of the cluster if the cluster is private.

nodePools List<String>

list of the IDs of the node pools in this cluster

nodeSubnet String

the node subnet of the cluster, if the cluster is private.

public_ Boolean

indicates if the cluster is public or private.

s3Buckets List<GetClusterS3Bucket>

list of IONOS Object Storage bucket configured for K8s usage

server String

cluster server (same as config[0].clusters[0].cluster.server but provided as an attribute for ease of use)

state String

one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"

userTokens Map<String,String>

a convenience map to be search the token of a specific user

key - is the user name
value - is the token

viableNodePoolVersions List<String>

A list of versions that may be used for node pools under this cluster

apiSubnetAllowLists string[]

access to the K8s API server is restricted to these CIDRs

availableUpgradeVersions string[]

A list of available versions for upgrading the cluster

caCrt string

base64 decoded cluster certificate authority data (provided as an attribute for direct use)

configs GetClusterConfig[]

structured kubernetes config consisting of a list with 1 item with the following fields:

api_version - Kubernetes API Version
kind - "Config"
current-context - string
clusters - list of
name - name of cluster
cluster - map of
certificate-authority-data - base64 decoded cluster CA data
server - server address in the form https://host:port
contexts - list of
name - context name
context - map of
cluster - cluster name
user - cluster user
users - list of
name - user name
user - map of
token - user token used for authentication

id string

id of the cluster

k8sVersion string

Kubernetes version

kubeConfig string

Kubernetes configuration

location string

this attribute is mandatory if the cluster is private.

maintenanceWindows GetClusterMaintenanceWindow[]

A maintenance window comprise of a day of the week and a time for maintenance to be allowed

name string

name of the cluster

natGatewayIp string

the NAT gateway IP of the cluster if the cluster is private.

nodePools string[]

list of the IDs of the node pools in this cluster

nodeSubnet string

the node subnet of the cluster, if the cluster is private.

public boolean

indicates if the cluster is public or private.

s3Buckets GetClusterS3Bucket[]

list of IONOS Object Storage bucket configured for K8s usage

server string

cluster server (same as config[0].clusters[0].cluster.server but provided as an attribute for ease of use)

state string

one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"

userTokens {[key: string]: string}

a convenience map to be search the token of a specific user

key - is the user name
value - is the token

viableNodePoolVersions string[]

A list of versions that may be used for node pools under this cluster

api_subnet_allow_lists Sequence[str]

access to the K8s API server is restricted to these CIDRs

available_upgrade_versions Sequence[str]

A list of available versions for upgrading the cluster

ca_crt str

base64 decoded cluster certificate authority data (provided as an attribute for direct use)

configs Sequence[GetClusterConfig]

structured kubernetes config consisting of a list with 1 item with the following fields:

api_version - Kubernetes API Version
kind - "Config"
current-context - string
clusters - list of
name - name of cluster
cluster - map of
certificate-authority-data - base64 decoded cluster CA data
server - server address in the form https://host:port
contexts - list of
name - context name
context - map of
cluster - cluster name
user - cluster user
users - list of
name - user name
user - map of
token - user token used for authentication

id str

id of the cluster

k8s_version str

Kubernetes version

kube_config str

Kubernetes configuration

location str

this attribute is mandatory if the cluster is private.

maintenance_windows Sequence[GetClusterMaintenanceWindow]

A maintenance window comprise of a day of the week and a time for maintenance to be allowed

name str

name of the cluster

nat_gateway_ip str

the NAT gateway IP of the cluster if the cluster is private.

node_pools Sequence[str]

list of the IDs of the node pools in this cluster

node_subnet str

the node subnet of the cluster, if the cluster is private.

public bool

indicates if the cluster is public or private.

s3_buckets Sequence[GetClusterS3Bucket]

list of IONOS Object Storage bucket configured for K8s usage

server str

cluster server (same as config[0].clusters[0].cluster.server but provided as an attribute for ease of use)

state str

one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"

user_tokens Mapping[str, str]

a convenience map to be search the token of a specific user

key - is the user name
value - is the token

viable_node_pool_versions Sequence[str]

A list of versions that may be used for node pools under this cluster

apiSubnetAllowLists List<String>

access to the K8s API server is restricted to these CIDRs

availableUpgradeVersions List<String>

A list of available versions for upgrading the cluster

caCrt String

base64 decoded cluster certificate authority data (provided as an attribute for direct use)

configs List<Property Map>

structured kubernetes config consisting of a list with 1 item with the following fields:

api_version - Kubernetes API Version
kind - "Config"
current-context - string
clusters - list of
name - name of cluster
cluster - map of
certificate-authority-data - base64 decoded cluster CA data
server - server address in the form https://host:port
contexts - list of
name - context name
context - map of
cluster - cluster name
user - cluster user
users - list of
name - user name
user - map of
token - user token used for authentication

id String

id of the cluster

k8sVersion String

Kubernetes version

kubeConfig String

Kubernetes configuration

location String

this attribute is mandatory if the cluster is private.

maintenanceWindows List<Property Map>

A maintenance window comprise of a day of the week and a time for maintenance to be allowed

name String

name of the cluster

natGatewayIp String

the NAT gateway IP of the cluster if the cluster is private.

nodePools List<String>

list of the IDs of the node pools in this cluster

nodeSubnet String

the node subnet of the cluster, if the cluster is private.

public Boolean

indicates if the cluster is public or private.

s3Buckets List<Property Map>

list of IONOS Object Storage bucket configured for K8s usage

server String

cluster server (same as config[0].clusters[0].cluster.server but provided as an attribute for ease of use)

state String

one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"

userTokens Map<String>

a convenience map to be search the token of a specific user

key - is the user name
value - is the token

viableNodePoolVersions List<String>

A list of versions that may be used for node pools under this cluster

Supporting Types

GetClusterConfig

ApiVersion string
Clusters List<Ionoscloud.GetClusterConfigCluster>
Contexts List<Ionoscloud.GetClusterConfigContext>
CurrentContext string
Kind string
Users List<Ionoscloud.GetClusterConfigUser>

ApiVersion string
Clusters []GetClusterConfigCluster
Contexts []GetClusterConfigContext
CurrentContext string
Kind string
Users []GetClusterConfigUser

apiVersion String
clusters List<GetClusterConfigCluster>
contexts List<GetClusterConfigContext>
currentContext String
kind String
users List<GetClusterConfigUser>

apiVersion string
clusters GetClusterConfigCluster[]
contexts GetClusterConfigContext[]
currentContext string
kind string
users GetClusterConfigUser[]

api_version str
clusters Sequence[GetClusterConfigCluster]
contexts Sequence[GetClusterConfigContext]
current_context str
kind str
users Sequence[GetClusterConfigUser]

apiVersion String
clusters List<Property Map>
contexts List<Property Map>
currentContext String
kind String
users List<Property Map>

GetClusterConfigCluster

Cluster Dictionary<string, string>
Name string: Name of an existing cluster that you want to search for.

Cluster map[string]string
Name string: Name of an existing cluster that you want to search for.

cluster Map<String,String>
name String: Name of an existing cluster that you want to search for.

cluster {[key: string]: string}
name string: Name of an existing cluster that you want to search for.

cluster Mapping[str, str]
name str: Name of an existing cluster that you want to search for.

cluster Map<String>
name String: Name of an existing cluster that you want to search for.

GetClusterConfigContext

Context Dictionary<string, string>
Name string: Name of an existing cluster that you want to search for.

Context map[string]string
Name string: Name of an existing cluster that you want to search for.

context Map<String,String>
name String: Name of an existing cluster that you want to search for.

context {[key: string]: string}
name string: Name of an existing cluster that you want to search for.

context Mapping[str, str]
name str: Name of an existing cluster that you want to search for.

context Map<String>
name String: Name of an existing cluster that you want to search for.

GetClusterConfigUser

Name string: Name of an existing cluster that you want to search for.
User Dictionary<string, string>

Name string: Name of an existing cluster that you want to search for.
User map[string]string

name String: Name of an existing cluster that you want to search for.
user Map<String,String>

name string: Name of an existing cluster that you want to search for.
user {[key: string]: string}

name str: Name of an existing cluster that you want to search for.
user Mapping[str, str]

name String: Name of an existing cluster that you want to search for.
user Map<String>

GetClusterMaintenanceWindow

DayOfTheWeek string: Day of the week when maintenance is allowed
Time string: A clock time in the day when maintenance is allowed

DayOfTheWeek string: Day of the week when maintenance is allowed
Time string: A clock time in the day when maintenance is allowed

dayOfTheWeek String: Day of the week when maintenance is allowed
time String: A clock time in the day when maintenance is allowed

dayOfTheWeek string: Day of the week when maintenance is allowed
time string: A clock time in the day when maintenance is allowed

day_of_the_week str: Day of the week when maintenance is allowed
time str: A clock time in the day when maintenance is allowed

dayOfTheWeek String: Day of the week when maintenance is allowed
time String: A clock time in the day when maintenance is allowed

GetClusterS3Bucket

Name string: Name of an existing cluster that you want to search for.

Name string: Name of an existing cluster that you want to search for.

name String: Name of an existing cluster that you want to search for.

name string: Name of an existing cluster that you want to search for.

name str: Name of an existing cluster that you want to search for.

name String: Name of an existing cluster that you want to search for.

Package Details

Repository: ionoscloud ionos-cloud/pulumi-ionoscloud
License: Apache-2.0
Notes: This Pulumi package is based on the ionoscloud Terraform Provider.

IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud

ionos-cloud/pulumi-ionoscloud

ionoscloud.k8s.getCluster

On this page

On this page

Example Usage

By ID

By Name

Example of accessing a kubernetes cluster using the user’s token

Example of accessing a kubernetes cluster using the token from the config

Using getCluster

getCluster Result

Supporting Types

GetClusterConfig

GetClusterConfigCluster

GetClusterConfigContext

GetClusterConfigUser

GetClusterMaintenanceWindow

GetClusterS3Bucket

Package Details

On this page

On this page