ionoscloud 6.7.6, Apr 14 25

ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionos-cloud/terraform-provider-ionoscloud

ionoscloud.getK8sCluster

Explore with Pulumi AI

ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionos-cloud/terraform-provider-ionoscloud

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.getK8sCluster({
    id: "cluster_id",
});

import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.get_k8s_cluster(id="cluster_id")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ionoscloud.LookupK8sCluster(ctx, &ionoscloud.LookupK8sClusterArgs{
			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.GetK8sCluster.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.IonoscloudFunctions;
import com.pulumi.ionoscloud.inputs.GetK8sClusterArgs;
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 = IonoscloudFunctions.getK8sCluster(GetK8sClusterArgs.builder()
            .id("cluster_id")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: ionoscloud:getK8sCluster
      arguments:
        id: cluster_id

By Name

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

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

import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.get_k8s_cluster(name="K8s Cluster Example")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ionoscloud.LookupK8sCluster(ctx, &ionoscloud.LookupK8sClusterArgs{
			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.GetK8sCluster.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.IonoscloudFunctions;
import com.pulumi.ionoscloud.inputs.GetK8sClusterArgs;
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 = IonoscloudFunctions.getK8sCluster(GetK8sClusterArgs.builder()
            .name("K8s Cluster Example")
            .build());

    }
}

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

Using getK8sCluster

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 getK8sCluster(args: GetK8sClusterArgs, opts?: InvokeOptions): Promise<GetK8sClusterResult>
function getK8sClusterOutput(args: GetK8sClusterOutputArgs, opts?: InvokeOptions): Output<GetK8sClusterResult>

def get_k8s_cluster(id: Optional[str] = None,
                    name: Optional[str] = None,
                    timeouts: Optional[GetK8sClusterTimeouts] = None,
                    opts: Optional[InvokeOptions] = None) -> GetK8sClusterResult
def get_k8s_cluster_output(id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    timeouts: Optional[pulumi.Input[GetK8sClusterTimeoutsArgs]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetK8sClusterResult]

func LookupK8sCluster(ctx *Context, args *LookupK8sClusterArgs, opts ...InvokeOption) (*LookupK8sClusterResult, error)
func LookupK8sClusterOutput(ctx *Context, args *LookupK8sClusterOutputArgs, opts ...InvokeOption) LookupK8sClusterResultOutput

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

public static class GetK8sCluster 
{
    public static Task<GetK8sClusterResult> InvokeAsync(GetK8sClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetK8sClusterResult> Invoke(GetK8sClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetK8sClusterResult> getK8sCluster(GetK8sClusterArgs args, InvokeOptions options)
public static Output<GetK8sClusterResult> getK8sCluster(GetK8sClusterArgs args, InvokeOptions options)

fn::invoke:
  function: ionoscloud:index/getK8sCluster:getK8sCluster
  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.

Timeouts GetK8sClusterTimeouts

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.

Timeouts GetK8sClusterTimeouts

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.

timeouts GetK8sClusterTimeouts

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.

timeouts GetK8sClusterTimeouts

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.

timeouts GetK8sClusterTimeouts

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.

timeouts Property Map

getK8sCluster 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<GetK8sClusterConfig>

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<GetK8sClusterMaintenanceWindow>

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<GetK8sClusterS3Bucket>

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

Timeouts GetK8sClusterTimeouts

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 []GetK8sClusterConfig

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 []GetK8sClusterMaintenanceWindow

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 []GetK8sClusterS3Bucket

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

Timeouts GetK8sClusterTimeouts

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<GetK8sClusterConfig>

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<GetK8sClusterMaintenanceWindow>

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<GetK8sClusterS3Bucket>

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

timeouts GetK8sClusterTimeouts

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 GetK8sClusterConfig[]

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 GetK8sClusterMaintenanceWindow[]

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 GetK8sClusterS3Bucket[]

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

timeouts GetK8sClusterTimeouts

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[GetK8sClusterConfig]

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[GetK8sClusterMaintenanceWindow]

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[GetK8sClusterS3Bucket]

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

timeouts GetK8sClusterTimeouts

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

timeouts Property Map

Supporting Types

GetK8sClusterConfig

ApiVersion string
Clusters List<GetK8sClusterConfigCluster>
Contexts List<GetK8sClusterConfigContext>
CurrentContext string
Kind string
Users List<GetK8sClusterConfigUser>

ApiVersion string
Clusters []GetK8sClusterConfigCluster
Contexts []GetK8sClusterConfigContext
CurrentContext string
Kind string
Users []GetK8sClusterConfigUser

apiVersion String
clusters List<GetK8sClusterConfigCluster>
contexts List<GetK8sClusterConfigContext>
currentContext String
kind String
users List<GetK8sClusterConfigUser>

apiVersion string
clusters GetK8sClusterConfigCluster[]
contexts GetK8sClusterConfigContext[]
currentContext string
kind string
users GetK8sClusterConfigUser[]

api_version str
clusters Sequence[GetK8sClusterConfigCluster]
contexts Sequence[GetK8sClusterConfigContext]
current_context str
kind str
users Sequence[GetK8sClusterConfigUser]

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

GetK8sClusterConfigCluster

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.

GetK8sClusterConfigContext

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.

GetK8sClusterConfigUser

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>

GetK8sClusterMaintenanceWindow

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

GetK8sClusterS3Bucket

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.

GetK8sClusterTimeouts

Create string
Default string
Delete string
Update string

Create string
Default string
Delete string
Update string

create String
default_ String
delete String
update String

create string
default string
delete string
update string

create str
default str
delete str
update str

create String
default String
delete String
update String

Package Details

Repository: ionoscloud ionos-cloud/terraform-provider-ionoscloud
License
Notes: This Pulumi package is based on the ionoscloud Terraform Provider.

ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionos-cloud/terraform-provider-ionoscloud

ionoscloud.getK8sCluster

On this page

On this page

Example Usage

By ID

By Name

Using getK8sCluster

getK8sCluster Result

Supporting Types

GetK8sClusterConfig

GetK8sClusterConfigCluster

GetK8sClusterConfigContext

GetK8sClusterConfigUser

GetK8sClusterMaintenanceWindow

GetK8sClusterS3Bucket

GetK8sClusterTimeouts

Package Details

On this page

On this page