getKubernetes

Vultr v2.27.1, Sep 30 25

Viewing docs for Vultr v2.27.1
published on Tuesday, Sep 30, 2025 by dirien

Schema (JSON)

dirien/pulumi-vultr

Viewing docs for Vultr v2.27.1
published on Tuesday, Sep 30, 2025 by dirien

Schema (JSON)

dirien/pulumi-vultr

Example Usage

Create a new VKE cluster:

import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const myVke = vultr.getKubernetes({
    filters: [{
        name: "label",
        values: ["my-lb-label"],
    }],
});

import pulumi
import pulumi_vultr as vultr

my_vke = vultr.get_kubernetes(filters=[{
    "name": "label",
    "values": ["my-lb-label"],
}])

package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.LookupKubernetes(ctx, &vultr.LookupKubernetesArgs{
			Filters: []vultr.GetKubernetesFilter{
				{
					Name: "label",
					Values: []string{
						"my-lb-label",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myVke = Vultr.GetKubernetes.Invoke(new()
    {
        Filters = new[]
        {
            new Vultr.Inputs.GetKubernetesFilterInputArgs
            {
                Name = "label",
                Values = new[]
                {
                    "my-lb-label",
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.VultrFunctions;
import com.pulumi.vultr.inputs.GetKubernetesArgs;
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 myVke = VultrFunctions.getKubernetes(GetKubernetesArgs.builder()
            .filters(GetKubernetesFilterArgs.builder()
                .name("label")
                .values("my-lb-label")
                .build())
            .build());

    }
}

variables:
  myVke:
    fn::invoke:
      function: vultr:getKubernetes
      arguments:
        filters:
          - name: label
            values:
              - my-lb-label

Using getKubernetes

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 getKubernetes(args: GetKubernetesArgs, opts?: InvokeOptions): Promise<GetKubernetesResult>
function getKubernetesOutput(args: GetKubernetesOutputArgs, opts?: InvokeOptions): Output<GetKubernetesResult>

def get_kubernetes(filters: Optional[Sequence[GetKubernetesFilter]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetKubernetesResult
def get_kubernetes_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetKubernetesFilterArgs]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesResult]

func LookupKubernetes(ctx *Context, args *LookupKubernetesArgs, opts ...InvokeOption) (*LookupKubernetesResult, error)
func LookupKubernetesOutput(ctx *Context, args *LookupKubernetesOutputArgs, opts ...InvokeOption) LookupKubernetesResultOutput

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

public static class GetKubernetes 
{
    public static Task<GetKubernetesResult> InvokeAsync(GetKubernetesArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesResult> Invoke(GetKubernetesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKubernetesResult> getKubernetes(GetKubernetesArgs args, InvokeOptions options)
public static Output<GetKubernetesResult> getKubernetes(GetKubernetesArgs args, InvokeOptions options)

fn::invoke:
  function: vultr:index/getKubernetes:getKubernetes
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<ediri.Vultr.Inputs.GetKubernetesFilter>: Query parameters for finding VKE.

Filters []GetKubernetesFilter: Query parameters for finding VKE.

filters List<GetKubernetesFilter>: Query parameters for finding VKE.

filters GetKubernetesFilter[]: Query parameters for finding VKE.

filters Sequence[GetKubernetesFilter]: Query parameters for finding VKE.

filters List<Property Map>: Query parameters for finding VKE.

getKubernetes Result

The following output properties are available:

ClientCertificate string: The base64 encoded public certificate used by clients to access the cluster.
ClientKey string: The base64 encoded private key used by clients to access the cluster.
ClusterCaCertificate string: The base64 encoded public certificate for the cluster's certificate authority.
ClusterSubnet string: IP range that your pods will run on in this cluster.
DateCreated string: Date node was created.
Endpoint string: Domain for your Kubernetes clusters control plane.
FirewallGroupId string: The ID of the firewall group managed by this cluster.
HaControlplanes bool: Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
Id string: ID of node.
Ip string: IP address of VKE cluster control plane.
KubeConfig string: Base64 encoded Kubeconfig for this VKE cluster.
Label string: Label of node.
NodePools List<ediri.Vultr.Outputs.GetKubernetesNodePool>: Contains the default node pool that was deployed.
Region string: The region your VKE cluster is deployed in.
ServiceSubnet string: IP range that services will run on this cluster.
Status string: Status of node.
Version string: The current kubernetes version your VKE cluster is running on.
Filters List<ediri.Vultr.Outputs.GetKubernetesFilter>

ClientCertificate string: The base64 encoded public certificate used by clients to access the cluster.
ClientKey string: The base64 encoded private key used by clients to access the cluster.
ClusterCaCertificate string: The base64 encoded public certificate for the cluster's certificate authority.
ClusterSubnet string: IP range that your pods will run on in this cluster.
DateCreated string: Date node was created.
Endpoint string: Domain for your Kubernetes clusters control plane.
FirewallGroupId string: The ID of the firewall group managed by this cluster.
HaControlplanes bool: Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
Id string: ID of node.
Ip string: IP address of VKE cluster control plane.
KubeConfig string: Base64 encoded Kubeconfig for this VKE cluster.
Label string: Label of node.
NodePools []GetKubernetesNodePool: Contains the default node pool that was deployed.
Region string: The region your VKE cluster is deployed in.
ServiceSubnet string: IP range that services will run on this cluster.
Status string: Status of node.
Version string: The current kubernetes version your VKE cluster is running on.
Filters []GetKubernetesFilter

clientCertificate String: The base64 encoded public certificate used by clients to access the cluster.
clientKey String: The base64 encoded private key used by clients to access the cluster.
clusterCaCertificate String: The base64 encoded public certificate for the cluster's certificate authority.
clusterSubnet String: IP range that your pods will run on in this cluster.
dateCreated String: Date node was created.
endpoint String: Domain for your Kubernetes clusters control plane.
firewallGroupId String: The ID of the firewall group managed by this cluster.
haControlplanes Boolean: Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
id String: ID of node.
ip String: IP address of VKE cluster control plane.
kubeConfig String: Base64 encoded Kubeconfig for this VKE cluster.
label String: Label of node.
nodePools List<GetKubernetesNodePool>: Contains the default node pool that was deployed.
region String: The region your VKE cluster is deployed in.
serviceSubnet String: IP range that services will run on this cluster.
status String: Status of node.
version String: The current kubernetes version your VKE cluster is running on.
filters List<GetKubernetesFilter>

clientCertificate string: The base64 encoded public certificate used by clients to access the cluster.
clientKey string: The base64 encoded private key used by clients to access the cluster.
clusterCaCertificate string: The base64 encoded public certificate for the cluster's certificate authority.
clusterSubnet string: IP range that your pods will run on in this cluster.
dateCreated string: Date node was created.
endpoint string: Domain for your Kubernetes clusters control plane.
firewallGroupId string: The ID of the firewall group managed by this cluster.
haControlplanes boolean: Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
id string: ID of node.
ip string: IP address of VKE cluster control plane.
kubeConfig string: Base64 encoded Kubeconfig for this VKE cluster.
label string: Label of node.
nodePools GetKubernetesNodePool[]: Contains the default node pool that was deployed.
region string: The region your VKE cluster is deployed in.
serviceSubnet string: IP range that services will run on this cluster.
status string: Status of node.
version string: The current kubernetes version your VKE cluster is running on.
filters GetKubernetesFilter[]

client_certificate str: The base64 encoded public certificate used by clients to access the cluster.
client_key str: The base64 encoded private key used by clients to access the cluster.
cluster_ca_certificate str: The base64 encoded public certificate for the cluster's certificate authority.
cluster_subnet str: IP range that your pods will run on in this cluster.
date_created str: Date node was created.
endpoint str: Domain for your Kubernetes clusters control plane.
firewall_group_id str: The ID of the firewall group managed by this cluster.
ha_controlplanes bool: Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
id str: ID of node.
ip str: IP address of VKE cluster control plane.
kube_config str: Base64 encoded Kubeconfig for this VKE cluster.
label str: Label of node.
node_pools Sequence[GetKubernetesNodePool]: Contains the default node pool that was deployed.
region str: The region your VKE cluster is deployed in.
service_subnet str: IP range that services will run on this cluster.
status str: Status of node.
version str: The current kubernetes version your VKE cluster is running on.
filters Sequence[GetKubernetesFilter]

clientCertificate String: The base64 encoded public certificate used by clients to access the cluster.
clientKey String: The base64 encoded private key used by clients to access the cluster.
clusterCaCertificate String: The base64 encoded public certificate for the cluster's certificate authority.
clusterSubnet String: IP range that your pods will run on in this cluster.
dateCreated String: Date node was created.
endpoint String: Domain for your Kubernetes clusters control plane.
firewallGroupId String: The ID of the firewall group managed by this cluster.
haControlplanes Boolean: Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
id String: ID of node.
ip String: IP address of VKE cluster control plane.
kubeConfig String: Base64 encoded Kubeconfig for this VKE cluster.
label String: Label of node.
nodePools List<Property Map>: Contains the default node pool that was deployed.
region String: The region your VKE cluster is deployed in.
serviceSubnet String: IP range that services will run on this cluster.
status String: Status of node.
version String: The current kubernetes version your VKE cluster is running on.
filters List<Property Map>

Supporting Types

GetKubernetesFilter

Name string: Attribute name to filter with.
Values List<string>: One or more values filter with.

Name string: Attribute name to filter with.
Values []string: One or more values filter with.

name String: Attribute name to filter with.
values List<String>: One or more values filter with.

name string: Attribute name to filter with.
values string[]: One or more values filter with.

name str: Attribute name to filter with.
values Sequence[str]: One or more values filter with.

name String: Attribute name to filter with.
values List<String>: One or more values filter with.

GetKubernetesNodePool

DateCreated string: Date node was created.
DateUpdated string: Date of node pool updates.
Id string: ID of node.
Label string: Label of node.
NodeQuantity int: Number of nodes within node pool.
Nodes List<ediri.Vultr.Inputs.GetKubernetesNodePoolNode>: Array that contains information about nodes within this node pool.
Plan string: Node plan that nodes are using within this node pool.
Status string: Status of node.
Tag string: Tag for node pool.
AutoScaler bool: Boolean indicating if the auto scaler for the default node pool is active.
Labels Dictionary<string, string>: Kubernetes node labels applied to the node pool.
MaxNodes int: The maximum number of nodes used by the auto scaler.
MinNodes int: The minimum number of nodes used by the auto scaler.
Taints List<ediri.Vultr.Inputs.GetKubernetesNodePoolTaint>: Kubernetes node taints applied to the node pool.
UserData string: The base64 encoded string containing the user data applied to nodes in the node pool.

DateCreated string: Date node was created.
DateUpdated string: Date of node pool updates.
Id string: ID of node.
Label string: Label of node.
NodeQuantity int: Number of nodes within node pool.
Nodes []GetKubernetesNodePoolNode: Array that contains information about nodes within this node pool.
Plan string: Node plan that nodes are using within this node pool.
Status string: Status of node.
Tag string: Tag for node pool.
AutoScaler bool: Boolean indicating if the auto scaler for the default node pool is active.
Labels map[string]string: Kubernetes node labels applied to the node pool.
MaxNodes int: The maximum number of nodes used by the auto scaler.
MinNodes int: The minimum number of nodes used by the auto scaler.
Taints []GetKubernetesNodePoolTaint: Kubernetes node taints applied to the node pool.
UserData string: The base64 encoded string containing the user data applied to nodes in the node pool.

dateCreated String: Date node was created.
dateUpdated String: Date of node pool updates.
id String: ID of node.
label String: Label of node.
nodeQuantity Integer: Number of nodes within node pool.
nodes List<GetKubernetesNodePoolNode>: Array that contains information about nodes within this node pool.
plan String: Node plan that nodes are using within this node pool.
status String: Status of node.
tag String: Tag for node pool.
autoScaler Boolean: Boolean indicating if the auto scaler for the default node pool is active.
labels Map<String,String>: Kubernetes node labels applied to the node pool.
maxNodes Integer: The maximum number of nodes used by the auto scaler.
minNodes Integer: The minimum number of nodes used by the auto scaler.
taints List<GetKubernetesNodePoolTaint>: Kubernetes node taints applied to the node pool.
userData String: The base64 encoded string containing the user data applied to nodes in the node pool.

dateCreated string: Date node was created.
dateUpdated string: Date of node pool updates.
id string: ID of node.
label string: Label of node.
nodeQuantity number: Number of nodes within node pool.
nodes GetKubernetesNodePoolNode[]: Array that contains information about nodes within this node pool.
plan string: Node plan that nodes are using within this node pool.
status string: Status of node.
tag string: Tag for node pool.
autoScaler boolean: Boolean indicating if the auto scaler for the default node pool is active.
labels {[key: string]: string}: Kubernetes node labels applied to the node pool.
maxNodes number: The maximum number of nodes used by the auto scaler.
minNodes number: The minimum number of nodes used by the auto scaler.
taints GetKubernetesNodePoolTaint[]: Kubernetes node taints applied to the node pool.
userData string: The base64 encoded string containing the user data applied to nodes in the node pool.

date_created str: Date node was created.
date_updated str: Date of node pool updates.
id str: ID of node.
label str: Label of node.
node_quantity int: Number of nodes within node pool.
nodes Sequence[GetKubernetesNodePoolNode]: Array that contains information about nodes within this node pool.
plan str: Node plan that nodes are using within this node pool.
status str: Status of node.
tag str: Tag for node pool.
auto_scaler bool: Boolean indicating if the auto scaler for the default node pool is active.
labels Mapping[str, str]: Kubernetes node labels applied to the node pool.
max_nodes int: The maximum number of nodes used by the auto scaler.
min_nodes int: The minimum number of nodes used by the auto scaler.
taints Sequence[GetKubernetesNodePoolTaint]: Kubernetes node taints applied to the node pool.
user_data str: The base64 encoded string containing the user data applied to nodes in the node pool.

dateCreated String: Date node was created.
dateUpdated String: Date of node pool updates.
id String: ID of node.
label String: Label of node.
nodeQuantity Number: Number of nodes within node pool.
nodes List<Property Map>: Array that contains information about nodes within this node pool.
plan String: Node plan that nodes are using within this node pool.
status String: Status of node.
tag String: Tag for node pool.
autoScaler Boolean: Boolean indicating if the auto scaler for the default node pool is active.
labels Map<String>: Kubernetes node labels applied to the node pool.
maxNodes Number: The maximum number of nodes used by the auto scaler.
minNodes Number: The minimum number of nodes used by the auto scaler.
taints List<Property Map>: Kubernetes node taints applied to the node pool.
userData String: The base64 encoded string containing the user data applied to nodes in the node pool.

GetKubernetesNodePoolNode

DateCreated string: Date node was created.
Id string: ID of node.
Label string: Label of node.
Status string: Status of node.

DateCreated string: Date node was created.
Id string: ID of node.
Label string: Label of node.
Status string: Status of node.

dateCreated String: Date node was created.
id String: ID of node.
label String: Label of node.
status String: Status of node.

dateCreated string: Date node was created.
id string: ID of node.
label string: Label of node.
status string: Status of node.

date_created str: Date node was created.
id str: ID of node.
label str: Label of node.
status str: Status of node.

dateCreated String: Date node was created.
id String: ID of node.
label String: Label of node.
status String: Status of node.

GetKubernetesNodePoolTaint

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: vultr dirien/pulumi-vultr
License: Apache-2.0
Notes: This Pulumi package is based on the vultr Terraform Provider.

Viewing docs for Vultr v2.27.1
published on Tuesday, Sep 30, 2025 by dirien

Schema (JSON)

dirien/pulumi-vultr

vultr.getKubernetes

On this page

On this page

Example Usage

Using getKubernetes

getKubernetes Result

Supporting Types

GetKubernetesFilter

GetKubernetesNodePool

GetKubernetesNodePoolNode

GetKubernetesNodePoolTaint

Package Details

On this page

On this page