getLkeCluster

Provides details about an LKE Cluster.

Example Usage

using Pulumi;
using Linode = Pulumi.Linode;

class MyStack : Stack
{
    public MyStack()
    {
        var my_cluster = Output.Create(Linode.GetLkeCluster.InvokeAsync(new Linode.GetLkeClusterArgs
        {
            Id = 123,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := linode.LookupLkeCluster(ctx, &GetLkeClusterArgs{
			Id: 123,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_linode as linode

my_cluster = linode.get_lke_cluster(id=123)
import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

const my_cluster = pulumi.output(linode.getLkeCluster({
    id: 123,
}));

Using getLkeCluster

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 getLkeCluster(args: GetLkeClusterArgs, opts?: InvokeOptions): Promise<GetLkeClusterResult>
function getLkeClusterOutput(args: GetLkeClusterOutputArgs, opts?: InvokeOptions): Output<GetLkeClusterResult>
def get_lke_cluster(id: Optional[int] = None,
                    opts: Optional[InvokeOptions] = None) -> GetLkeClusterResult
def get_lke_cluster_output(id: Optional[pulumi.Input[int]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetLkeClusterResult]
func LookupLkeCluster(ctx *Context, args *LookupLkeClusterArgs, opts ...InvokeOption) (*LookupLkeClusterResult, error)
func LookupLkeClusterOutput(ctx *Context, args *LookupLkeClusterOutputArgs, opts ...InvokeOption) LookupLkeClusterResultOutput

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

public static class GetLkeCluster 
{
    public static Task<GetLkeClusterResult> InvokeAsync(GetLkeClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetLkeClusterResult> Invoke(GetLkeClusterInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Id int
The LKE Cluster’s ID.
Id int
The LKE Cluster’s ID.
id number
The LKE Cluster’s ID.
id int
The LKE Cluster’s ID.

getLkeCluster Result

The following output properties are available:

ApiEndpoints List<string>
The endpoints for the Kubernetes API server.
ControlPlanes List<GetLkeClusterControlPlane>
Id int
The ID of the node.
K8sVersion string
The Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.17).
Kubeconfig string
The base64 encoded kubeconfig for the Kubernetes cluster.
Label string
Pools List<GetLkeClusterPool>
Node pools associated with this cluster.
Region string
This Kubernetes cluster’s location.
Status string
The status of the node. (ready, not_ready)
Tags List<string>
The tags applied to the cluster.
ApiEndpoints []string
The endpoints for the Kubernetes API server.
ControlPlanes []GetLkeClusterControlPlane
Id int
The ID of the node.
K8sVersion string
The Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.17).
Kubeconfig string
The base64 encoded kubeconfig for the Kubernetes cluster.
Label string
Pools []GetLkeClusterPool
Node pools associated with this cluster.
Region string
This Kubernetes cluster’s location.
Status string
The status of the node. (ready, not_ready)
Tags []string
The tags applied to the cluster.
apiEndpoints string[]
The endpoints for the Kubernetes API server.
controlPlanes GetLkeClusterControlPlane[]
id number
The ID of the node.
k8sVersion string
The Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.17).
kubeconfig string
The base64 encoded kubeconfig for the Kubernetes cluster.
label string
pools GetLkeClusterPool[]
Node pools associated with this cluster.
region string
This Kubernetes cluster’s location.
status string
The status of the node. (ready, not_ready)
tags string[]
The tags applied to the cluster.
api_endpoints Sequence[str]
The endpoints for the Kubernetes API server.
control_planes Sequence[GetLkeClusterControlPlane]
id int
The ID of the node.
k8s_version str
The Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.17).
kubeconfig str
The base64 encoded kubeconfig for the Kubernetes cluster.
label str
pools Sequence[GetLkeClusterPool]
Node pools associated with this cluster.
region str
This Kubernetes cluster’s location.
status str
The status of the node. (ready, not_ready)
tags Sequence[str]
The tags applied to the cluster.

Supporting Types

GetLkeClusterControlPlane

GetLkeClusterPool

Autoscalers List<GetLkeClusterPoolAutoscaler>
The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
Count int
The number of nodes in the Node Pool.
Id int
The LKE Cluster’s ID.
Nodes List<GetLkeClusterPoolNode>
The nodes in the Node Pool.
Type string
The linode type for all of the nodes in the Node Pool. See all node types here.
Autoscalers []GetLkeClusterPoolAutoscaler
The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
Count int
The number of nodes in the Node Pool.
Id int
The LKE Cluster’s ID.
Nodes []GetLkeClusterPoolNode
The nodes in the Node Pool.
Type string
The linode type for all of the nodes in the Node Pool. See all node types here.
autoscalers GetLkeClusterPoolAutoscaler[]
The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
count number
The number of nodes in the Node Pool.
id number
The LKE Cluster’s ID.
nodes GetLkeClusterPoolNode[]
The nodes in the Node Pool.
type string
The linode type for all of the nodes in the Node Pool. See all node types here.
autoscalers Sequence[GetLkeClusterPoolAutoscaler]
The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
count int
The number of nodes in the Node Pool.
id int
The LKE Cluster’s ID.
nodes Sequence[GetLkeClusterPoolNode]
The nodes in the Node Pool.
type str
The linode type for all of the nodes in the Node Pool. See all node types here.

GetLkeClusterPoolAutoscaler

Max int
The maximum number of nodes to autoscale to.
Min int
The minimum number of nodes to autoscale to.
Max int
The maximum number of nodes to autoscale to.
Min int
The minimum number of nodes to autoscale to.
max number
The maximum number of nodes to autoscale to.
min number
The minimum number of nodes to autoscale to.
max int
The maximum number of nodes to autoscale to.
min int
The minimum number of nodes to autoscale to.

GetLkeClusterPoolNode

Id string
The LKE Cluster’s ID.
InstanceId int
The ID of the underlying Linode instance.
Status string
The status of the node. (ready, not_ready)
Id string
The LKE Cluster’s ID.
InstanceId int
The ID of the underlying Linode instance.
Status string
The status of the node. (ready, not_ready)
id string
The LKE Cluster’s ID.
instanceId number
The ID of the underlying Linode instance.
status string
The status of the node. (ready, not_ready)
id str
The LKE Cluster’s ID.
instance_id int
The ID of the underlying Linode instance.
status str
The status of the node. (ready, not_ready)

Package Details

Repository
https://github.com/pulumi/pulumi-linode
License
Apache-2.0
Notes
This Pulumi package is based on the linode Terraform Provider.