Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. getCseKubernetesCluster
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.getCseKubernetesCluster

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Provides a data source to read Kubernetes clusters in VMware Cloud Director with Container Service Extension (CSE) installed and running.

    Supported in provider v3.12+

    Supports the following Container Service Extension versions:

    • 4.1.0
    • 4.1.1 / 4.1.1a
    • 4.2.0
    • 4.2.1
    • 4.2.2
    • 4.2.3

    To install CSE in VMware Cloud Director, please follow this guide

    Example Usage

    With ID

    The cluster ID identifies unequivocally the cluster within VCD, and can be obtained with the CSE Kubernetes Clusters UI Plugin, by selecting the desired cluster and obtaining the ID from the displayed information.

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

const myCluster = vcd.getCseKubernetesCluster({
    clusterId: "urn:vcloud:entity:vmware:capvcdCluster:e8e82bcc-50a1-484f-9dd0-20965ab3e865",
});

    import pulumi
import pulumi_vcd as vcd

my_cluster = vcd.get_cse_kubernetes_cluster(cluster_id="urn:vcloud:entity:vmware:capvcdCluster:e8e82bcc-50a1-484f-9dd0-20965ab3e865")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vcd.LookupCseKubernetesCluster(ctx, &vcd.LookupCseKubernetesClusterArgs{
			ClusterId: pulumi.StringRef("urn:vcloud:entity:vmware:capvcdCluster:e8e82bcc-50a1-484f-9dd0-20965ab3e865"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myCluster = Vcd.GetCseKubernetesCluster.Invoke(new()
    {
        ClusterId = "urn:vcloud:entity:vmware:capvcdCluster:e8e82bcc-50a1-484f-9dd0-20965ab3e865",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetCseKubernetesClusterArgs;
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 myCluster = VcdFunctions.getCseKubernetesCluster(GetCseKubernetesClusterArgs.builder()
            .clusterId("urn:vcloud:entity:vmware:capvcdCluster:e8e82bcc-50a1-484f-9dd0-20965ab3e865")
            .build());

    }
}

    variables:
  myCluster:
    fn::invoke:
      function: vcd:getCseKubernetesCluster
      arguments:
        clusterId: urn:vcloud:entity:vmware:capvcdCluster:e8e82bcc-50a1-484f-9dd0-20965ab3e865

    Using getCseKubernetesCluster

    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 getCseKubernetesCluster(args: GetCseKubernetesClusterArgs, opts?: InvokeOptions): Promise<GetCseKubernetesClusterResult>
function getCseKubernetesClusterOutput(args: GetCseKubernetesClusterOutputArgs, opts?: InvokeOptions): Output<GetCseKubernetesClusterResult>
    def get_cse_kubernetes_cluster(cluster_id: Optional[str] = None,
                               cse_version: Optional[str] = None,
                               id: Optional[str] = None,
                               name: Optional[str] = None,
                               org_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetCseKubernetesClusterResult
def get_cse_kubernetes_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                               cse_version: Optional[pulumi.Input[str]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               org_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetCseKubernetesClusterResult]
    func LookupCseKubernetesCluster(ctx *Context, args *LookupCseKubernetesClusterArgs, opts ...InvokeOption) (*LookupCseKubernetesClusterResult, error)
func LookupCseKubernetesClusterOutput(ctx *Context, args *LookupCseKubernetesClusterOutputArgs, opts ...InvokeOption) LookupCseKubernetesClusterResultOutput

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

    public static class GetCseKubernetesCluster 
{
    public static Task<GetCseKubernetesClusterResult> InvokeAsync(GetCseKubernetesClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetCseKubernetesClusterResult> Invoke(GetCseKubernetesClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCseKubernetesClusterResult> getCseKubernetesCluster(GetCseKubernetesClusterArgs args, InvokeOptions options)
public static Output<GetCseKubernetesClusterResult> getCseKubernetesCluster(GetCseKubernetesClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: vcd:index/getCseKubernetesCluster:getCseKubernetesCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    Unequivocally identifies a cluster in VCD. Either cluster_id or name must be set.
    CseVersion string
    Specifies the CSE Version of the cluster to find when name is used instead of cluster_id.
    Id string
    Name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    OrgId string
    The ID of the Organization to which the Kubernetes cluster belongs. Only used if cluster_id is not set. Must be present if name is used.
    ClusterId string
    Unequivocally identifies a cluster in VCD. Either cluster_id or name must be set.
    CseVersion string
    Specifies the CSE Version of the cluster to find when name is used instead of cluster_id.
    Id string
    Name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    OrgId string
    The ID of the Organization to which the Kubernetes cluster belongs. Only used if cluster_id is not set. Must be present if name is used.
    clusterId String
    Unequivocally identifies a cluster in VCD. Either cluster_id or name must be set.
    cseVersion String
    Specifies the CSE Version of the cluster to find when name is used instead of cluster_id.
    id String
    name String
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    orgId String
    The ID of the Organization to which the Kubernetes cluster belongs. Only used if cluster_id is not set. Must be present if name is used.
    clusterId string
    Unequivocally identifies a cluster in VCD. Either cluster_id or name must be set.
    cseVersion string
    Specifies the CSE Version of the cluster to find when name is used instead of cluster_id.
    id string
    name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    orgId string
    The ID of the Organization to which the Kubernetes cluster belongs. Only used if cluster_id is not set. Must be present if name is used.
    cluster_id str
    Unequivocally identifies a cluster in VCD. Either cluster_id or name must be set.
    cse_version str
    Specifies the CSE Version of the cluster to find when name is used instead of cluster_id.
    id str
    name str
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    org_id str
    The ID of the Organization to which the Kubernetes cluster belongs. Only used if cluster_id is not set. Must be present if name is used.
    clusterId String
    Unequivocally identifies a cluster in VCD. Either cluster_id or name must be set.
    cseVersion String
    Specifies the CSE Version of the cluster to find when name is used instead of cluster_id.
    id String
    name String
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    orgId String
    The ID of the Organization to which the Kubernetes cluster belongs. Only used if cluster_id is not set. Must be present if name is used.

    getCseKubernetesCluster Result

    The following output properties are available:

    Supporting Types

    GetCseKubernetesClusterControlPlane

    GetCseKubernetesClusterDefaultStorageClass

    Filesystem string
    Name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    ReclaimPolicy string
    StorageProfileId string
    Filesystem string
    Name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    ReclaimPolicy string
    StorageProfileId string
    filesystem String
    name String
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    reclaimPolicy String
    storageProfileId String
    filesystem string
    name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    reclaimPolicy string
    storageProfileId string
    filesystem str
    name str
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    reclaim_policy str
    storage_profile_id str
    filesystem String
    name String
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    reclaimPolicy String
    storageProfileId String

    GetCseKubernetesClusterEvent

    Details string
    Name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    OccurredAt string
    ResourceId string
    Type string
    Details string
    Name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    OccurredAt string
    ResourceId string
    Type string
    details String
    name String
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    occurredAt String
    resourceId String
    type String
    details string
    name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    occurredAt string
    resourceId string
    type string
    details str
    name str
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    occurred_at str
    resource_id str
    type str
    details String
    name String
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    occurredAt String
    resourceId String
    type String

    GetCseKubernetesClusterWorkerPool

    AutoscalerMaxReplicas double
    AutoscalerMinReplicas double
    DiskSizeGi double
    MachineCount double
    Name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    PlacementPolicyId string
    SizingPolicyId string
    StorageProfileId string
    VgpuPolicyId string
    AutoscalerMaxReplicas float64
    AutoscalerMinReplicas float64
    DiskSizeGi float64
    MachineCount float64
    Name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    PlacementPolicyId string
    SizingPolicyId string
    StorageProfileId string
    VgpuPolicyId string
    autoscalerMaxReplicas Double
    autoscalerMinReplicas Double
    diskSizeGi Double
    machineCount Double
    name String
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    placementPolicyId String
    sizingPolicyId String
    storageProfileId String
    vgpuPolicyId String
    autoscalerMaxReplicas number
    autoscalerMinReplicas number
    diskSizeGi number
    machineCount number
    name string
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    placementPolicyId string
    sizingPolicyId string
    storageProfileId string
    vgpuPolicyId string
    autoscaler_max_replicas float
    autoscaler_min_replicas float
    disk_size_gi float
    machine_count float
    name str
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    placement_policy_id str
    sizing_policy_id str
    storage_profile_id str
    vgpu_policy_id str
    autoscalerMaxReplicas Number
    autoscalerMinReplicas Number
    diskSizeGi Number
    machineCount Number
    name String
    Allows to find a Kubernetes cluster by name inside the given Organization with ID org_id. Either cluster_id or name must be set. This argument requires cse_version and org_id to be set.
    placementPolicyId String
    sizingPolicyId String
    storageProfileId String
    vgpuPolicyId String

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd