Rancher 2 v3.9.0, Jan 18 23

rancher2.getCluster

Use this data source to retrieve information about a Rancher v2 cluster.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    var foo_custom = Rancher2.GetCluster.Invoke(new()
    {
        Name = "foo-custom",
    });

});

package main

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.LookupCluster(ctx, &rancher2.LookupClusterArgs{
			Name: "foo-custom",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.Rancher2Functions;
import com.pulumi.rancher2.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 foo-custom = Rancher2Functions.getCluster(GetClusterArgs.builder()
            .name("foo-custom")
            .build());

    }
}

import pulumi
import pulumi_rancher2 as rancher2

foo_custom = rancher2.get_cluster(name="foo-custom")

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

const foo-custom = rancher2.getCluster({
    name: "foo-custom",
});

variables:
  foo-custom:
    fn::invoke:
      Function: rancher2:getCluster
      Arguments:
        name: foo-custom

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(name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: rancher2:index/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the Cluster (string)

Name string: The name of the Cluster (string)

name String: The name of the Cluster (string)

name string: The name of the Cluster (string)

name str: The name of the Cluster (string)

name String: The name of the Cluster (string)

getCluster Result

The following output properties are available:

AgentEnvVars List<string>: (Computed) Optional Agent Env Vars for Rancher agent. Just for Rancher v2.5.6 and above (list)
AksConfig GetClusterAksConfig: (Computed) The Azure aks configuration for aks Clusters. Conflicts with aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
AksConfigV2 GetClusterAksConfigV2: (Optional) The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)
Annotations Dictionary<string, object>: (Computed) Annotations for Node Pool object (map)
CaCert string: (Computed) K8s cluster ca cert (string)
ClusterAuthEndpoint GetClusterClusterAuthEndpoint: (Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
ClusterMonitoringInput GetClusterClusterMonitoringInput: (Computed) Cluster monitoring config (list maxitems:1)
ClusterRegistrationToken GetClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
ClusterTemplateAnswers GetClusterClusterTemplateAnswers: (Computed) Cluster template answers (list maxitems:1)
ClusterTemplateId string: (Computed) Cluster template ID (string)
ClusterTemplateQuestions List<GetClusterClusterTemplateQuestion>: (Computed) Cluster template questions (list)
ClusterTemplateRevisionId string: (Computed) Cluster template revision ID (string)
DefaultPodSecurityPolicyTemplateId string: (Optional/Computed) Default pod security policy template id (string)
DefaultProjectId string: (Computed) Default project ID for the cluster (string)
Description string: (Computed) The description for Cluster (string)
Driver string: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
EksConfig GetClusterEksConfig: (Computed) The Amazon eks configuration for eks Conflicts with aks_config, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
EksConfigV2 GetClusterEksConfigV2: (Computed) The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, gke_config_v2, oke_config, k3s_config and rke_config. For Rancher v2.5.x or above (list maxitems:1)
EnableClusterAlerting bool
EnableClusterMonitoring bool: (Computed) Enable built-in cluster monitoring. Default false (bool)
EnableNetworkPolicy bool: (Computed) Enable project network isolation. Default false (bool)
FleetWorkspaceName string: (Computed) Fleet workspace name (string)
GkeConfig GetClusterGkeConfig: (Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1) (list maxitems:1)
GkeConfigV2 GetClusterGkeConfigV2: (Computed) The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, oke_config, k3s_config and rke_config. For Rancher v2.5.8 or above (list maxitems:1)
Id string: The provider-assigned unique ID for this managed resource.
K3sConfig GetClusterK3sConfig: (Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and rke_config (list maxitems:1)
KubeConfig string: (Computed) Kube Config generated for the cluster (string)
Labels Dictionary<string, object>: (Computed) Labels for Node Pool object (map)
Name string
OkeConfig GetClusterOkeConfig: (Computed) The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)
Rke2Config GetClusterRke2Config: (Computed) The RKE2 configuration for rke2 Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, oke_config, k3s_config and rke_config (list maxitems:1)
RkeConfig GetClusterRkeConfig: (Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and k3s_config (list maxitems:1)
ScheduledClusterScans List<GetClusterScheduledClusterScan>
SystemProjectId string: (Computed) System project ID for the cluster (string)

AgentEnvVars []string: (Computed) Optional Agent Env Vars for Rancher agent. Just for Rancher v2.5.6 and above (list)
AksConfig GetClusterAksConfig: (Computed) The Azure aks configuration for aks Clusters. Conflicts with aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
AksConfigV2 GetClusterAksConfigV2: (Optional) The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)
Annotations map[string]interface{}: (Computed) Annotations for Node Pool object (map)
CaCert string: (Computed) K8s cluster ca cert (string)
ClusterAuthEndpoint GetClusterClusterAuthEndpoint: (Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
ClusterMonitoringInput GetClusterClusterMonitoringInput: (Computed) Cluster monitoring config (list maxitems:1)
ClusterRegistrationToken GetClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
ClusterTemplateAnswers GetClusterClusterTemplateAnswers: (Computed) Cluster template answers (list maxitems:1)
ClusterTemplateId string: (Computed) Cluster template ID (string)
ClusterTemplateQuestions []GetClusterClusterTemplateQuestion: (Computed) Cluster template questions (list)
ClusterTemplateRevisionId string: (Computed) Cluster template revision ID (string)
DefaultPodSecurityPolicyTemplateId string: (Optional/Computed) Default pod security policy template id (string)
DefaultProjectId string: (Computed) Default project ID for the cluster (string)
Description string: (Computed) The description for Cluster (string)
Driver string: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
EksConfig GetClusterEksConfig: (Computed) The Amazon eks configuration for eks Conflicts with aks_config, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
EksConfigV2 GetClusterEksConfigV2: (Computed) The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, gke_config_v2, oke_config, k3s_config and rke_config. For Rancher v2.5.x or above (list maxitems:1)
EnableClusterAlerting bool
EnableClusterMonitoring bool: (Computed) Enable built-in cluster monitoring. Default false (bool)
EnableNetworkPolicy bool: (Computed) Enable project network isolation. Default false (bool)
FleetWorkspaceName string: (Computed) Fleet workspace name (string)
GkeConfig GetClusterGkeConfig: (Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1) (list maxitems:1)
GkeConfigV2 GetClusterGkeConfigV2: (Computed) The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, oke_config, k3s_config and rke_config. For Rancher v2.5.8 or above (list maxitems:1)
Id string: The provider-assigned unique ID for this managed resource.
K3sConfig GetClusterK3sConfig: (Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and rke_config (list maxitems:1)
KubeConfig string: (Computed) Kube Config generated for the cluster (string)
Labels map[string]interface{}: (Computed) Labels for Node Pool object (map)
Name string
OkeConfig GetClusterOkeConfig: (Computed) The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)
Rke2Config GetClusterRke2Config: (Computed) The RKE2 configuration for rke2 Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, oke_config, k3s_config and rke_config (list maxitems:1)
RkeConfig GetClusterRkeConfig: (Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and k3s_config (list maxitems:1)
ScheduledClusterScans []GetClusterScheduledClusterScan
SystemProjectId string: (Computed) System project ID for the cluster (string)

agentEnvVars List<String>: (Computed) Optional Agent Env Vars for Rancher agent. Just for Rancher v2.5.6 and above (list)
aksConfig GetClusterAksConfig: (Computed) The Azure aks configuration for aks Clusters. Conflicts with aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
aksConfigV2 GetClusterAksConfigV2: (Optional) The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)
annotations Map<String,Object>: (Computed) Annotations for Node Pool object (map)
caCert String: (Computed) K8s cluster ca cert (string)
clusterAuthEndpoint GetClusterClusterAuthEndpoint: (Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
clusterMonitoringInput GetClusterClusterMonitoringInput: (Computed) Cluster monitoring config (list maxitems:1)
clusterRegistrationToken GetClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
clusterTemplateAnswers GetClusterClusterTemplateAnswers: (Computed) Cluster template answers (list maxitems:1)
clusterTemplateId String: (Computed) Cluster template ID (string)
clusterTemplateQuestions List<GetClusterClusterTemplateQuestion>: (Computed) Cluster template questions (list)
clusterTemplateRevisionId String: (Computed) Cluster template revision ID (string)
defaultPodSecurityPolicyTemplateId String: (Optional/Computed) Default pod security policy template id (string)
defaultProjectId String: (Computed) Default project ID for the cluster (string)
description String: (Computed) The description for Cluster (string)
driver String: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
eksConfig GetClusterEksConfig: (Computed) The Amazon eks configuration for eks Conflicts with aks_config, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
eksConfigV2 GetClusterEksConfigV2: (Computed) The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, gke_config_v2, oke_config, k3s_config and rke_config. For Rancher v2.5.x or above (list maxitems:1)
enableClusterAlerting Boolean
enableClusterMonitoring Boolean: (Computed) Enable built-in cluster monitoring. Default false (bool)
enableNetworkPolicy Boolean: (Computed) Enable project network isolation. Default false (bool)
fleetWorkspaceName String: (Computed) Fleet workspace name (string)
gkeConfig GetClusterGkeConfig: (Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1) (list maxitems:1)
gkeConfigV2 GetClusterGkeConfigV2: (Computed) The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, oke_config, k3s_config and rke_config. For Rancher v2.5.8 or above (list maxitems:1)
id String: The provider-assigned unique ID for this managed resource.
k3sConfig GetClusterK3sConfig: (Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and rke_config (list maxitems:1)
kubeConfig String: (Computed) Kube Config generated for the cluster (string)
labels Map<String,Object>: (Computed) Labels for Node Pool object (map)
name String
okeConfig GetClusterOkeConfig: (Computed) The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)
rke2Config GetClusterRke2Config: (Computed) The RKE2 configuration for rke2 Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, oke_config, k3s_config and rke_config (list maxitems:1)
rkeConfig GetClusterRkeConfig: (Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and k3s_config (list maxitems:1)
scheduledClusterScans List<GetClusterScheduledClusterScan>
systemProjectId String: (Computed) System project ID for the cluster (string)

agentEnvVars string[]: (Computed) Optional Agent Env Vars for Rancher agent. Just for Rancher v2.5.6 and above (list)
aksConfig GetClusterAksConfig: (Computed) The Azure aks configuration for aks Clusters. Conflicts with aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
aksConfigV2 GetClusterAksConfigV2: (Optional) The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)
annotations {[key: string]: any}: (Computed) Annotations for Node Pool object (map)
caCert string: (Computed) K8s cluster ca cert (string)
clusterAuthEndpoint GetClusterClusterAuthEndpoint: (Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
clusterMonitoringInput GetClusterClusterMonitoringInput: (Computed) Cluster monitoring config (list maxitems:1)
clusterRegistrationToken GetClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
clusterTemplateAnswers GetClusterClusterTemplateAnswers: (Computed) Cluster template answers (list maxitems:1)
clusterTemplateId string: (Computed) Cluster template ID (string)
clusterTemplateQuestions GetClusterClusterTemplateQuestion[]: (Computed) Cluster template questions (list)
clusterTemplateRevisionId string: (Computed) Cluster template revision ID (string)
defaultPodSecurityPolicyTemplateId string: (Optional/Computed) Default pod security policy template id (string)
defaultProjectId string: (Computed) Default project ID for the cluster (string)
description string: (Computed) The description for Cluster (string)
driver string: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
eksConfig GetClusterEksConfig: (Computed) The Amazon eks configuration for eks Conflicts with aks_config, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
eksConfigV2 GetClusterEksConfigV2: (Computed) The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, gke_config_v2, oke_config, k3s_config and rke_config. For Rancher v2.5.x or above (list maxitems:1)
enableClusterAlerting boolean
enableClusterMonitoring boolean: (Computed) Enable built-in cluster monitoring. Default false (bool)
enableNetworkPolicy boolean: (Computed) Enable project network isolation. Default false (bool)
fleetWorkspaceName string: (Computed) Fleet workspace name (string)
gkeConfig GetClusterGkeConfig: (Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1) (list maxitems:1)
gkeConfigV2 GetClusterGkeConfigV2: (Computed) The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, oke_config, k3s_config and rke_config. For Rancher v2.5.8 or above (list maxitems:1)
id string: The provider-assigned unique ID for this managed resource.
k3sConfig GetClusterK3sConfig: (Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and rke_config (list maxitems:1)
kubeConfig string: (Computed) Kube Config generated for the cluster (string)
labels {[key: string]: any}: (Computed) Labels for Node Pool object (map)
name string
okeConfig GetClusterOkeConfig: (Computed) The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)
rke2Config GetClusterRke2Config: (Computed) The RKE2 configuration for rke2 Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, oke_config, k3s_config and rke_config (list maxitems:1)
rkeConfig GetClusterRkeConfig: (Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and k3s_config (list maxitems:1)
scheduledClusterScans GetClusterScheduledClusterScan[]
systemProjectId string: (Computed) System project ID for the cluster (string)

agent_env_vars Sequence[str]: (Computed) Optional Agent Env Vars for Rancher agent. Just for Rancher v2.5.6 and above (list)
aks_config GetClusterAksConfig: (Computed) The Azure aks configuration for aks Clusters. Conflicts with aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
aks_config_v2 GetClusterAksConfigV2: (Optional) The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)
annotations Mapping[str, Any]: (Computed) Annotations for Node Pool object (map)
ca_cert str: (Computed) K8s cluster ca cert (string)
cluster_auth_endpoint GetClusterClusterAuthEndpoint: (Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
cluster_monitoring_input GetClusterClusterMonitoringInput: (Computed) Cluster monitoring config (list maxitems:1)
cluster_registration_token GetClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
cluster_template_answers GetClusterClusterTemplateAnswers: (Computed) Cluster template answers (list maxitems:1)
cluster_template_id str: (Computed) Cluster template ID (string)
cluster_template_questions Sequence[GetClusterClusterTemplateQuestion]: (Computed) Cluster template questions (list)
cluster_template_revision_id str: (Computed) Cluster template revision ID (string)
default_pod_security_policy_template_id str: (Optional/Computed) Default pod security policy template id (string)
default_project_id str: (Computed) Default project ID for the cluster (string)
description str: (Computed) The description for Cluster (string)
driver str: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
eks_config GetClusterEksConfig: (Computed) The Amazon eks configuration for eks Conflicts with aks_config, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
eks_config_v2 GetClusterEksConfigV2: (Computed) The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, gke_config_v2, oke_config, k3s_config and rke_config. For Rancher v2.5.x or above (list maxitems:1)
enable_cluster_alerting bool
enable_cluster_monitoring bool: (Computed) Enable built-in cluster monitoring. Default false (bool)
enable_network_policy bool: (Computed) Enable project network isolation. Default false (bool)
fleet_workspace_name str: (Computed) Fleet workspace name (string)
gke_config GetClusterGkeConfig: (Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1) (list maxitems:1)
gke_config_v2 GetClusterGkeConfigV2: (Computed) The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, oke_config, k3s_config and rke_config. For Rancher v2.5.8 or above (list maxitems:1)
id str: The provider-assigned unique ID for this managed resource.
k3s_config GetClusterK3sConfig: (Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and rke_config (list maxitems:1)
kube_config str: (Computed) Kube Config generated for the cluster (string)
labels Mapping[str, Any]: (Computed) Labels for Node Pool object (map)
name str
oke_config GetClusterOkeConfig: (Computed) The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)
rke2_config GetClusterRke2Config: (Computed) The RKE2 configuration for rke2 Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, oke_config, k3s_config and rke_config (list maxitems:1)
rke_config GetClusterRkeConfig: (Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and k3s_config (list maxitems:1)
scheduled_cluster_scans Sequence[GetClusterScheduledClusterScan]
system_project_id str: (Computed) System project ID for the cluster (string)

agentEnvVars List<String>: (Computed) Optional Agent Env Vars for Rancher agent. Just for Rancher v2.5.6 and above (list)
aksConfig Property Map: (Computed) The Azure aks configuration for aks Clusters. Conflicts with aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
aksConfigV2 Property Map: (Optional) The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)
annotations Map<Any>: (Computed) Annotations for Node Pool object (map)
caCert String: (Computed) K8s cluster ca cert (string)
clusterAuthEndpoint Property Map: (Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
clusterMonitoringInput Property Map: (Computed) Cluster monitoring config (list maxitems:1)
clusterRegistrationToken Property Map: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
clusterTemplateAnswers Property Map: (Computed) Cluster template answers (list maxitems:1)
clusterTemplateId String: (Computed) Cluster template ID (string)
clusterTemplateQuestions List<Property Map>: (Computed) Cluster template questions (list)
clusterTemplateRevisionId String: (Computed) Cluster template revision ID (string)
defaultPodSecurityPolicyTemplateId String: (Optional/Computed) Default pod security policy template id (string)
defaultProjectId String: (Computed) Default project ID for the cluster (string)
description String: (Computed) The description for Cluster (string)
driver String: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
eksConfig Property Map: (Computed) The Amazon eks configuration for eks Conflicts with aks_config, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1)
eksConfigV2 Property Map: (Computed) The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, gke_config_v2, oke_config, k3s_config and rke_config. For Rancher v2.5.x or above (list maxitems:1)
enableClusterAlerting Boolean
enableClusterMonitoring Boolean: (Computed) Enable built-in cluster monitoring. Default false (bool)
enableNetworkPolicy Boolean: (Computed) Enable project network isolation. Default false (bool)
fleetWorkspaceName String: (Computed) Fleet workspace name (string)
gkeConfig Property Map: (Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config_v2, oke_config, k3s_config and rke_config (list maxitems:1) (list maxitems:1)
gkeConfigV2 Property Map: (Computed) The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, oke_config, k3s_config and rke_config. For Rancher v2.5.8 or above (list maxitems:1)
id String: The provider-assigned unique ID for this managed resource.
k3sConfig Property Map: (Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and rke_config (list maxitems:1)
kubeConfig String: (Computed) Kube Config generated for the cluster (string)
labels Map<Any>: (Computed) Labels for Node Pool object (map)
name String
okeConfig Property Map: (Computed) The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)
rke2Config Property Map: (Computed) The RKE2 configuration for rke2 Clusters. Conflicts with aks_config, aks_config_v2, eks_config, gke_config, oke_config, k3s_config and rke_config (list maxitems:1)
rkeConfig Property Map: (Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and k3s_config (list maxitems:1)
scheduledClusterScans List<Property Map>
systemProjectId String: (Computed) System project ID for the cluster (string)

Supporting Types

GetClusterAksConfig

AgentDnsPrefix string

ClientId string

ClientSecret string

KubernetesVersion string

LoadBalancerSku string

MasterDnsPrefix string

ResourceGroup string

SshPublicKeyContents string

Subnet string

SubscriptionId string

Tag Dictionary<string, object>

Deprecated:

Use tags argument instead as []string

Tags List<string>

TenantId string

VirtualNetwork string

VirtualNetworkResourceGroup string

AadServerAppSecret string

AadTenantId string

AddClientAppId string

AddServerAppId string

AdminUsername string

AgentOsDiskSize int

AgentPoolName string

AgentStorageProfile string

AgentVmSize string

AuthBaseUrl string

BaseUrl string

Count int

DnsServiceIp string

DockerBridgeCidr string

EnableHttpApplicationRouting bool

EnableMonitoring bool

Location string

LogAnalyticsWorkspace string

LogAnalyticsWorkspaceResourceGroup string

MaxPods int

NetworkPlugin string

NetworkPolicy string

PodCidr string

ServiceCidr string

AgentDnsPrefix string

ClientId string

ClientSecret string

KubernetesVersion string

LoadBalancerSku string

MasterDnsPrefix string

ResourceGroup string

SshPublicKeyContents string

Subnet string

SubscriptionId string

Tag map[string]interface{}

Deprecated:

Use tags argument instead as []string

Tags []string

TenantId string

VirtualNetwork string

VirtualNetworkResourceGroup string

AadServerAppSecret string

AadTenantId string

AddClientAppId string

AddServerAppId string

AdminUsername string

AgentOsDiskSize int

AgentPoolName string

AgentStorageProfile string

AgentVmSize string

AuthBaseUrl string

BaseUrl string

Count int

DnsServiceIp string

DockerBridgeCidr string

EnableHttpApplicationRouting bool

EnableMonitoring bool

Location string

LogAnalyticsWorkspace string

LogAnalyticsWorkspaceResourceGroup string

MaxPods int

NetworkPlugin string

NetworkPolicy string

PodCidr string

ServiceCidr string

agentDnsPrefix String

clientId String

clientSecret String

kubernetesVersion String

loadBalancerSku String

masterDnsPrefix String

resourceGroup String

sshPublicKeyContents String

subnet String

subscriptionId String

tag Map<String,Object>

Deprecated:

Use tags argument instead as []string

tags List<String>

tenantId String

virtualNetwork String

virtualNetworkResourceGroup String

aadServerAppSecret String

aadTenantId String

addClientAppId String

addServerAppId String

adminUsername String

agentOsDiskSize Integer

agentPoolName String

agentStorageProfile String

agentVmSize String

authBaseUrl String

baseUrl String

count Integer

dnsServiceIp String

dockerBridgeCidr String

enableHttpApplicationRouting Boolean

enableMonitoring Boolean

location String

logAnalyticsWorkspace String

logAnalyticsWorkspaceResourceGroup String

maxPods Integer

networkPlugin String

networkPolicy String

podCidr String

serviceCidr String

agentDnsPrefix string

clientId string

clientSecret string

kubernetesVersion string

loadBalancerSku string

masterDnsPrefix string

resourceGroup string

sshPublicKeyContents string

subnet string

subscriptionId string

tag {[key: string]: any}

Deprecated:

Use tags argument instead as []string

tags string[]

tenantId string

virtualNetwork string

virtualNetworkResourceGroup string

aadServerAppSecret string

aadTenantId string

addClientAppId string

addServerAppId string

adminUsername string

agentOsDiskSize number

agentPoolName string

agentStorageProfile string

agentVmSize string

authBaseUrl string

baseUrl string

count number

dnsServiceIp string

dockerBridgeCidr string

enableHttpApplicationRouting boolean

enableMonitoring boolean

location string

logAnalyticsWorkspace string

logAnalyticsWorkspaceResourceGroup string

maxPods number

networkPlugin string

networkPolicy string

podCidr string

serviceCidr string

agent_dns_prefix str

client_id str

client_secret str

kubernetes_version str

load_balancer_sku str

master_dns_prefix str

resource_group str

ssh_public_key_contents str

subnet str

subscription_id str

tag Mapping[str, Any]

Deprecated:

Use tags argument instead as []string

tags Sequence[str]

tenant_id str

virtual_network str

virtual_network_resource_group str

aad_server_app_secret str

aad_tenant_id str

add_client_app_id str

add_server_app_id str

admin_username str

agent_os_disk_size int

agent_pool_name str

agent_storage_profile str

agent_vm_size str

auth_base_url str

base_url str

count int

dns_service_ip str

docker_bridge_cidr str

enable_http_application_routing bool

enable_monitoring bool

location str

log_analytics_workspace str

log_analytics_workspace_resource_group str

max_pods int

network_plugin str

network_policy str

pod_cidr str

service_cidr str

agentDnsPrefix String

clientId String

clientSecret String

kubernetesVersion String

loadBalancerSku String

masterDnsPrefix String

resourceGroup String

sshPublicKeyContents String

subnet String

subscriptionId String

tag Map<Any>

Deprecated:

Use tags argument instead as []string

tags List<String>

tenantId String

virtualNetwork String

virtualNetworkResourceGroup String

aadServerAppSecret String

aadTenantId String

addClientAppId String

addServerAppId String

adminUsername String

agentOsDiskSize Number

agentPoolName String

agentStorageProfile String

agentVmSize String

authBaseUrl String

baseUrl String

count Number

dnsServiceIp String

dockerBridgeCidr String

enableHttpApplicationRouting Boolean

enableMonitoring Boolean

location String

logAnalyticsWorkspace String

logAnalyticsWorkspaceResourceGroup String

maxPods Number

networkPlugin String

networkPolicy String

podCidr String

serviceCidr String

GetClusterAksConfigV2

CloudCredentialId string
HttpApplicationRouting bool
LinuxAdminUsername string
LinuxSshPublicKey string
LoadBalancerSku string
LogAnalyticsWorkspaceGroup string
LogAnalyticsWorkspaceName string
Monitoring bool
Name string: The name of the Cluster (string)
NetworkDnsServiceIp string
NetworkDockerBridgeCidr string
NetworkPodCidr string
NetworkPolicy string
NetworkServiceCidr string
PrivateCluster bool
ResourceGroup string
ResourceLocation string
Subnet string
Tags Dictionary<string, object>
VirtualNetwork string
VirtualNetworkResourceGroup string
AuthBaseUrl string
AuthorizedIpRanges List<string>
BaseUrl string
DnsPrefix string
Imported bool
KubernetesVersion string
NetworkPlugin string
NodePools List<GetClusterAksConfigV2NodePool>

CloudCredentialId string
HttpApplicationRouting bool
LinuxAdminUsername string
LinuxSshPublicKey string
LoadBalancerSku string
LogAnalyticsWorkspaceGroup string
LogAnalyticsWorkspaceName string
Monitoring bool
Name string: The name of the Cluster (string)
NetworkDnsServiceIp string
NetworkDockerBridgeCidr string
NetworkPodCidr string
NetworkPolicy string
NetworkServiceCidr string
PrivateCluster bool
ResourceGroup string
ResourceLocation string
Subnet string
Tags map[string]interface{}
VirtualNetwork string
VirtualNetworkResourceGroup string
AuthBaseUrl string
AuthorizedIpRanges []string
BaseUrl string
DnsPrefix string
Imported bool
KubernetesVersion string
NetworkPlugin string
NodePools []GetClusterAksConfigV2NodePool

cloudCredentialId String
httpApplicationRouting Boolean
linuxAdminUsername String
linuxSshPublicKey String
loadBalancerSku String
logAnalyticsWorkspaceGroup String
logAnalyticsWorkspaceName String
monitoring Boolean
name String: The name of the Cluster (string)
networkDnsServiceIp String
networkDockerBridgeCidr String
networkPodCidr String
networkPolicy String
networkServiceCidr String
privateCluster Boolean
resourceGroup String
resourceLocation String
subnet String
tags Map<String,Object>
virtualNetwork String
virtualNetworkResourceGroup String
authBaseUrl String
authorizedIpRanges List<String>
baseUrl String
dnsPrefix String
imported Boolean
kubernetesVersion String
networkPlugin String
nodePools List<GetClusterAksConfigV2NodePool>

cloudCredentialId string
httpApplicationRouting boolean
linuxAdminUsername string
linuxSshPublicKey string
loadBalancerSku string
logAnalyticsWorkspaceGroup string
logAnalyticsWorkspaceName string
monitoring boolean
name string: The name of the Cluster (string)
networkDnsServiceIp string
networkDockerBridgeCidr string
networkPodCidr string
networkPolicy string
networkServiceCidr string
privateCluster boolean
resourceGroup string
resourceLocation string
subnet string
tags {[key: string]: any}
virtualNetwork string
virtualNetworkResourceGroup string
authBaseUrl string
authorizedIpRanges string[]
baseUrl string
dnsPrefix string
imported boolean
kubernetesVersion string
networkPlugin string
nodePools GetClusterAksConfigV2NodePool[]

cloud_credential_id str
http_application_routing bool
linux_admin_username str
linux_ssh_public_key str
load_balancer_sku str
log_analytics_workspace_group str
log_analytics_workspace_name str
monitoring bool
name str: The name of the Cluster (string)
network_dns_service_ip str
network_docker_bridge_cidr str
network_pod_cidr str
network_policy str
network_service_cidr str
private_cluster bool
resource_group str
resource_location str
subnet str
tags Mapping[str, Any]
virtual_network str
virtual_network_resource_group str
auth_base_url str
authorized_ip_ranges Sequence[str]
base_url str
dns_prefix str
imported bool
kubernetes_version str
network_plugin str
node_pools Sequence[GetClusterAksConfigV2NodePool]

cloudCredentialId String
httpApplicationRouting Boolean
linuxAdminUsername String
linuxSshPublicKey String
loadBalancerSku String
logAnalyticsWorkspaceGroup String
logAnalyticsWorkspaceName String
monitoring Boolean
name String: The name of the Cluster (string)
networkDnsServiceIp String
networkDockerBridgeCidr String
networkPodCidr String
networkPolicy String
networkServiceCidr String
privateCluster Boolean
resourceGroup String
resourceLocation String
subnet String
tags Map<Any>
virtualNetwork String
virtualNetworkResourceGroup String
authBaseUrl String
authorizedIpRanges List<String>
baseUrl String
dnsPrefix String
imported Boolean
kubernetesVersion String
networkPlugin String
nodePools List<Property Map>

GetClusterAksConfigV2NodePool

Name string: The name of the Cluster (string)
VmSize string
AvailabilityZones List<string>
Count int
EnableAutoScaling bool
MaxCount int
MaxPods int
MinCount int
Mode string
OrchestratorVersion string
OsDiskSizeGb int
OsDiskType string
OsType string

Name string: The name of the Cluster (string)
VmSize string
AvailabilityZones []string
Count int
EnableAutoScaling bool
MaxCount int
MaxPods int
MinCount int
Mode string
OrchestratorVersion string
OsDiskSizeGb int
OsDiskType string
OsType string

name String: The name of the Cluster (string)
vmSize String
availabilityZones List<String>
count Integer
enableAutoScaling Boolean
maxCount Integer
maxPods Integer
minCount Integer
mode String
orchestratorVersion String
osDiskSizeGb Integer
osDiskType String
osType String

name string: The name of the Cluster (string)
vmSize string
availabilityZones string[]
count number
enableAutoScaling boolean
maxCount number
maxPods number
minCount number
mode string
orchestratorVersion string
osDiskSizeGb number
osDiskType string
osType string

name str: The name of the Cluster (string)
vm_size str
availability_zones Sequence[str]
count int
enable_auto_scaling bool
max_count int
max_pods int
min_count int
mode str
orchestrator_version str
os_disk_size_gb int
os_disk_type str
os_type str

name String: The name of the Cluster (string)
vmSize String
availabilityZones List<String>
count Number
enableAutoScaling Boolean
maxCount Number
maxPods Number
minCount Number
mode String
orchestratorVersion String
osDiskSizeGb Number
osDiskType String
osType String

GetClusterClusterAuthEndpoint

CaCerts string
Enabled bool
Fqdn string

CaCerts string
Enabled bool
Fqdn string

caCerts String
enabled Boolean
fqdn String

caCerts string
enabled boolean
fqdn string

ca_certs str
enabled bool
fqdn str

caCerts String
enabled Boolean
fqdn String

GetClusterClusterMonitoringInput

Answers Dictionary<string, object>
Version string

Answers map[string]interface{}
Version string

answers Map<String,Object>
version String

answers {[key: string]: any}
version string

answers Mapping[str, Any]
version str

answers Map<Any>
version String

GetClusterClusterRegistrationToken

Annotations Dictionary<string, object>: (Computed) Annotations for Node Pool object (map)
ClusterId string
Command string
Id string: (Computed) The ID of the resource (string)
InsecureCommand string
InsecureNodeCommand string
InsecureWindowsNodeCommand string
Labels Dictionary<string, object>: (Computed) Labels for Node Pool object (map)
ManifestUrl string
Name string: The name of the Cluster (string)
NodeCommand string
Token string
WindowsNodeCommand string

Annotations map[string]interface{}: (Computed) Annotations for Node Pool object (map)
ClusterId string
Command string
Id string: (Computed) The ID of the resource (string)
InsecureCommand string
InsecureNodeCommand string
InsecureWindowsNodeCommand string
Labels map[string]interface{}: (Computed) Labels for Node Pool object (map)
ManifestUrl string
Name string: The name of the Cluster (string)
NodeCommand string
Token string
WindowsNodeCommand string

annotations Map<String,Object>: (Computed) Annotations for Node Pool object (map)
clusterId String
command String
id String: (Computed) The ID of the resource (string)
insecureCommand String
insecureNodeCommand String
insecureWindowsNodeCommand String
labels Map<String,Object>: (Computed) Labels for Node Pool object (map)
manifestUrl String
name String: The name of the Cluster (string)
nodeCommand String
token String
windowsNodeCommand String

annotations {[key: string]: any}: (Computed) Annotations for Node Pool object (map)
clusterId string
command string
id string: (Computed) The ID of the resource (string)
insecureCommand string
insecureNodeCommand string
insecureWindowsNodeCommand string
labels {[key: string]: any}: (Computed) Labels for Node Pool object (map)
manifestUrl string
name string: The name of the Cluster (string)
nodeCommand string
token string
windowsNodeCommand string

annotations Mapping[str, Any]: (Computed) Annotations for Node Pool object (map)
cluster_id str
command str
id str: (Computed) The ID of the resource (string)
insecure_command str
insecure_node_command str
insecure_windows_node_command str
labels Mapping[str, Any]: (Computed) Labels for Node Pool object (map)
manifest_url str
name str: The name of the Cluster (string)
node_command str
token str
windows_node_command str