Class Cluster

Provides a Rancher v2 Cluster resource. This can be used to create Clusters for Rancher v2 environments and retrieve their information.

Inheritance

System.Object

Resource

CustomResource

Cluster

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Rancher2

Assembly: Pulumi.Rancher2.dll

Syntax

public class Cluster : CustomResource

Constructors

View Source

Cluster(String, ClusterArgs, CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

Declaration

public Cluster(string name, ClusterArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClusterArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AksConfig

The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config, k3s_config and rke_config (list maxitems:1)

Declaration

public Output<ClusterAksConfig> AksConfig { get; }

Property Value

Type	Description
Output<ClusterAksConfig>

View Source

Annotations

Annotations for cluster registration token object (map)

Declaration

public Output<ImmutableDictionary<string, object>> Annotations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

ClusterAuthEndpoint

Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

Declaration

public Output<ClusterClusterAuthEndpoint> ClusterAuthEndpoint { get; }

Property Value

Type	Description
Output<ClusterClusterAuthEndpoint>

View Source

ClusterMonitoringInput

Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

Declaration

public Output<ClusterClusterMonitoringInput> ClusterMonitoringInput { get; }

Property Value

Type	Description
Output<ClusterClusterMonitoringInput>

View Source

ClusterRegistrationToken

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

Declaration

public Output<ClusterClusterRegistrationToken> ClusterRegistrationToken { get; }

Property Value

Type	Description
Output<ClusterClusterRegistrationToken>

View Source

ClusterTemplateAnswers

Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)

Declaration

public Output<ClusterClusterTemplateAnswers> ClusterTemplateAnswers { get; }

Property Value

Type	Description
Output<ClusterClusterTemplateAnswers>

View Source

ClusterTemplateId

Cluster template ID. Just for Rancher v2.3.x and above (string)

Declaration

public Output<string> ClusterTemplateId { get; }

Property Value

Type	Description
Output<System.String>

View Source

ClusterTemplateQuestions

Cluster template questions. Just for Rancher v2.3.x and above (list)

Declaration

public Output<ImmutableArray<ClusterClusterTemplateQuestion>> ClusterTemplateQuestions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ClusterClusterTemplateQuestion>>

View Source

ClusterTemplateRevisionId

Cluster template revision ID. Just for Rancher v2.3.x and above (string)

Declaration

public Output<string> ClusterTemplateRevisionId { get; }

Property Value

Type	Description
Output<System.String>

View Source

DefaultPodSecurityPolicyTemplateId

Default pod security policy template id (string)

Declaration

public Output<string> DefaultPodSecurityPolicyTemplateId { get; }

Property Value

Type	Description
Output<System.String>

View Source

DefaultProjectId

(Computed) Default project ID for the cluster (string)

Declaration

public Output<string> DefaultProjectId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Description

An optional description of this cluster (string)

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

DesiredAgentImage

Desired agent image. Just for Rancher v2.3.x and above (string)

Declaration

public Output<string> DesiredAgentImage { get; }

Property Value

Type	Description
Output<System.String>

View Source

DesiredAuthImage

Desired auth image. Just for Rancher v2.3.x and above (string)

Declaration

public Output<string> DesiredAuthImage { get; }

Property Value

Type	Description
Output<System.String>

View Source

DockerRootDir

Desired auth image. Just for Rancher v2.3.x and above (string)

Declaration

public Output<string> DockerRootDir { get; }

Property Value

Type	Description
Output<System.String>

View Source

Driver

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

Declaration

public Output<string> Driver { get; }

Property Value

Type	Description
Output<System.String>

View Source

EksConfig

The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config, k3s_config and rke_config (list maxitems:1)

Declaration

public Output<ClusterEksConfig> EksConfig { get; }

Property Value

Type	Description
Output<ClusterEksConfig>

View Source

EnableClusterAlerting

Enable built-in cluster alerting. Default false (bool)

Declaration

public Output<bool?> EnableClusterAlerting { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

EnableClusterIstio

Enable built-in cluster istio. Default false. Just for Rancher v2.3.x and above (bool)

Declaration

public Output<bool?> EnableClusterIstio { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

EnableClusterMonitoring

Enable built-in cluster monitoring. Default false (bool)

Declaration

public Output<bool?> EnableClusterMonitoring { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

EnableNetworkPolicy

Enable project network isolation. Default false (bool)

Declaration

public Output<bool?> EnableNetworkPolicy { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

GkeConfig

The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, k3s_config and rke_config (list maxitems:1)

Declaration

public Output<ClusterGkeConfig> GkeConfig { get; }

Property Value

Type	Description
Output<ClusterGkeConfig>

View Source

K3sConfig

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)

Declaration

public Output<ClusterK3sConfig> K3sConfig { get; }

Property Value

Type	Description
Output<ClusterK3sConfig>

View Source

KubeConfig

(Computed/Sensitive) Kube Config generated for the cluster (string)

Declaration

public Output<string> KubeConfig { get; }

Property Value

Type	Description
Output<System.String>

View Source

Labels

Labels for cluster registration token object (map)

Declaration

public Output<ImmutableDictionary<string, object>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

Name

Name of cluster registration token (string)

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

RkeConfig

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config and k3s_config (list maxitems:1)

Declaration

public Output<ClusterRkeConfig> RkeConfig { get; }

Property Value

Type	Description
Output<ClusterRkeConfig>

View Source

ScheduledClusterScan

Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)

Declaration

public Output<ClusterScheduledClusterScan> ScheduledClusterScan { get; }

Property Value

Type	Description
Output<ClusterScheduledClusterScan>

View Source

SystemProjectId

(Computed) System project ID for the cluster (string)

Declaration

public Output<string> SystemProjectId { get; }

Property Value

Type	Description
Output<System.String>

View Source

WindowsPreferedCluster

Windows preferred cluster. Default: false (bool)

Declaration

public Output<bool?> WindowsPreferedCluster { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Methods

View Source

Get(String, Input<String>, ClusterState, CustomResourceOptions)

Get an existing Cluster resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Cluster Get(string name, Input<string> id, ClusterState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ClusterState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Cluster