Linode v4.30.0 published on Friday, Nov 8, 2024 by Pulumi
linode.getLkeCluster
Explore with Pulumi AI
Provides details about an LKE Cluster. For more information, see the Linode APIv4 docs.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";
const my-cluster = linode.getLkeCluster({
id: 123,
});
import pulumi
import pulumi_linode as linode
my_cluster = linode.get_lke_cluster(id=123)
package main
import (
"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := linode.LookupLkeCluster(ctx, &linode.LookupLkeClusterArgs{
Id: 123,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;
return await Deployment.RunAsync(() =>
{
var my_cluster = Linode.GetLkeCluster.Invoke(new()
{
Id = 123,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetLkeClusterArgs;
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 my-cluster = LinodeFunctions.getLkeCluster(GetLkeClusterArgs.builder()
.id(123)
.build());
}
}
variables:
my-cluster:
fn::invoke:
Function: linode:getLkeCluster
Arguments:
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(control_planes: Optional[Sequence[GetLkeClusterControlPlane]] = None,
id: Optional[int] = None,
pools: Optional[Sequence[GetLkeClusterPool]] = None,
opts: Optional[InvokeOptions] = None) -> GetLkeClusterResult
def get_lke_cluster_output(control_planes: Optional[pulumi.Input[Sequence[pulumi.Input[GetLkeClusterControlPlaneArgs]]]] = None,
id: Optional[pulumi.Input[int]] = None,
pools: Optional[pulumi.Input[Sequence[pulumi.Input[GetLkeClusterPoolArgs]]]] = 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)
}
public static CompletableFuture<GetLkeClusterResult> getLkeCluster(GetLkeClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: linode:index/getLkeCluster:getLkeCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Id int
- The LKE Cluster's ID.
- Control
Planes List<GetLke Cluster Control Plane> - The settings for the Kubernetes Control Plane.
- Pools
List<Get
Lke Cluster Pool> - Node pools associated with this cluster.
- Id int
- The LKE Cluster's ID.
- Control
Planes []GetLke Cluster Control Plane - The settings for the Kubernetes Control Plane.
- Pools
[]Get
Lke Cluster Pool - Node pools associated with this cluster.
- id Integer
- The LKE Cluster's ID.
- control
Planes List<GetLke Cluster Control Plane> - The settings for the Kubernetes Control Plane.
- pools
List<Get
Lke Cluster Pool> - Node pools associated with this cluster.
- id number
- The LKE Cluster's ID.
- control
Planes GetLke Cluster Control Plane[] - The settings for the Kubernetes Control Plane.
- pools
Get
Lke Cluster Pool[] - Node pools associated with this cluster.
- id int
- The LKE Cluster's ID.
- control_
planes Sequence[GetLke Cluster Control Plane] - The settings for the Kubernetes Control Plane.
- pools
Sequence[Get
Lke Cluster Pool] - Node pools associated with this cluster.
- id Number
- The LKE Cluster's ID.
- control
Planes List<Property Map> - The settings for the Kubernetes Control Plane.
- pools List<Property Map>
- Node pools associated with this cluster.
getLkeCluster Result
The following output properties are available:
- Api
Endpoints List<string> - The endpoints for the Kubernetes API server.
- Created string
- When this Kubernetes cluster was created.
- Dashboard
Url string - The Kubernetes Dashboard access URL for this cluster.
- Id int
- The ID of the node.
- K8s
Version 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
- The unique label for the cluster.
- Region string
- This Kubernetes cluster's location.
- Status string
- The status of the node. (
ready
,not_ready
) - List<string>
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- Updated string
- When this Kubernetes cluster was updated.
- Control
Planes List<GetLke Cluster Control Plane> - The settings for the Kubernetes Control Plane.
- Pools
List<Get
Lke Cluster Pool> - Node pools associated with this cluster.
- Api
Endpoints []string - The endpoints for the Kubernetes API server.
- Created string
- When this Kubernetes cluster was created.
- Dashboard
Url string - The Kubernetes Dashboard access URL for this cluster.
- Id int
- The ID of the node.
- K8s
Version 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
- The unique label for the cluster.
- Region string
- This Kubernetes cluster's location.
- Status string
- The status of the node. (
ready
,not_ready
) - []string
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- Updated string
- When this Kubernetes cluster was updated.
- Control
Planes []GetLke Cluster Control Plane - The settings for the Kubernetes Control Plane.
- Pools
[]Get
Lke Cluster Pool - Node pools associated with this cluster.
- api
Endpoints List<String> - The endpoints for the Kubernetes API server.
- created String
- When this Kubernetes cluster was created.
- dashboard
Url String - The Kubernetes Dashboard access URL for this cluster.
- id Integer
- The ID of the node.
- k8s
Version 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
- The unique label for the cluster.
- region String
- This Kubernetes cluster's location.
- status String
- The status of the node. (
ready
,not_ready
) - List<String>
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- updated String
- When this Kubernetes cluster was updated.
- control
Planes List<GetLke Cluster Control Plane> - The settings for the Kubernetes Control Plane.
- pools
List<Get
Lke Cluster Pool> - Node pools associated with this cluster.
- api
Endpoints string[] - The endpoints for the Kubernetes API server.
- created string
- When this Kubernetes cluster was created.
- dashboard
Url string - The Kubernetes Dashboard access URL for this cluster.
- id number
- The ID of the node.
- k8s
Version 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
- The unique label for the cluster.
- region string
- This Kubernetes cluster's location.
- status string
- The status of the node. (
ready
,not_ready
) - string[]
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- updated string
- When this Kubernetes cluster was updated.
- control
Planes GetLke Cluster Control Plane[] - The settings for the Kubernetes Control Plane.
- pools
Get
Lke Cluster Pool[] - Node pools associated with this cluster.
- api_
endpoints Sequence[str] - The endpoints for the Kubernetes API server.
- created str
- When this Kubernetes cluster was created.
- dashboard_
url str - The Kubernetes Dashboard access URL for this cluster.
- 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
- The unique label for the cluster.
- region str
- This Kubernetes cluster's location.
- status str
- The status of the node. (
ready
,not_ready
) - Sequence[str]
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- updated str
- When this Kubernetes cluster was updated.
- control_
planes Sequence[GetLke Cluster Control Plane] - The settings for the Kubernetes Control Plane.
- pools
Sequence[Get
Lke Cluster Pool] - Node pools associated with this cluster.
- api
Endpoints List<String> - The endpoints for the Kubernetes API server.
- created String
- When this Kubernetes cluster was created.
- dashboard
Url String - The Kubernetes Dashboard access URL for this cluster.
- id Number
- The ID of the node.
- k8s
Version 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
- The unique label for the cluster.
- region String
- This Kubernetes cluster's location.
- status String
- The status of the node. (
ready
,not_ready
) - List<String>
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- updated String
- When this Kubernetes cluster was updated.
- control
Planes List<Property Map> - The settings for the Kubernetes Control Plane.
- pools List<Property Map>
- Node pools associated with this cluster.
Supporting Types
GetLkeClusterControlPlane
- High
Availability bool - Whether High Availability is enabled for the cluster Control Plane.
- Acls
List<Get
Lke Cluster Control Plane Acl> - The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
- High
Availability bool - Whether High Availability is enabled for the cluster Control Plane.
- Acls
[]Get
Lke Cluster Control Plane Acl - The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
- high
Availability Boolean - Whether High Availability is enabled for the cluster Control Plane.
- acls
List<Get
Lke Cluster Control Plane Acl> - The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
- high
Availability boolean - Whether High Availability is enabled for the cluster Control Plane.
- acls
Get
Lke Cluster Control Plane Acl[] - The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
- high_
availability bool - Whether High Availability is enabled for the cluster Control Plane.
- acls
Sequence[Get
Lke Cluster Control Plane Acl] - The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
- high
Availability Boolean - Whether High Availability is enabled for the cluster Control Plane.
- acls List<Property Map>
- The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
GetLkeClusterControlPlaneAcl
- Enabled bool
- The default policy. A value of true means a default policy of DENY. A value of false means a default policy of ALLOW.
- Addresses
List<Get
Lke Cluster Control Plane Acl Address> - A list of ip addresses to allow.
- Enabled bool
- The default policy. A value of true means a default policy of DENY. A value of false means a default policy of ALLOW.
- Addresses
[]Get
Lke Cluster Control Plane Acl Address - A list of ip addresses to allow.
- enabled Boolean
- The default policy. A value of true means a default policy of DENY. A value of false means a default policy of ALLOW.
- addresses
List<Get
Lke Cluster Control Plane Acl Address> - A list of ip addresses to allow.
- enabled boolean
- The default policy. A value of true means a default policy of DENY. A value of false means a default policy of ALLOW.
- addresses
Get
Lke Cluster Control Plane Acl Address[] - A list of ip addresses to allow.
- enabled bool
- The default policy. A value of true means a default policy of DENY. A value of false means a default policy of ALLOW.
- addresses
Sequence[Get
Lke Cluster Control Plane Acl Address] - A list of ip addresses to allow.
- enabled Boolean
- The default policy. A value of true means a default policy of DENY. A value of false means a default policy of ALLOW.
- addresses List<Property Map>
- A list of ip addresses to allow.
GetLkeClusterControlPlaneAclAddress
GetLkeClusterPool
- Count int
- The number of nodes in the Node Pool.
- Disk
Encryption string - The disk encryption policy for nodes in this pool.
- Id int
- The LKE Cluster's ID.
- Labels Dictionary<string, string>
- Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
- List<string>
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- Taints
List<Get
Lke Cluster Pool Taint> - Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
- Type string
- The linode type for all of the nodes in the Node Pool. See all node types here.
- Autoscalers
List<Get
Lke Cluster Pool Autoscaler> - The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
- Disks
List<Get
Lke Cluster Pool Disk> - This Node Pool’s custom disk layout.
- Nodes
List<Get
Lke Cluster Pool Node> - The nodes in the Node Pool.
- Count int
- The number of nodes in the Node Pool.
- Disk
Encryption string - The disk encryption policy for nodes in this pool.
- Id int
- The LKE Cluster's ID.
- Labels map[string]string
- Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
- []string
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- Taints
[]Get
Lke Cluster Pool Taint - Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
- Type string
- The linode type for all of the nodes in the Node Pool. See all node types here.
- Autoscalers
[]Get
Lke Cluster Pool Autoscaler - The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
- Disks
[]Get
Lke Cluster Pool Disk - This Node Pool’s custom disk layout.
- Nodes
[]Get
Lke Cluster Pool Node - The nodes in the Node Pool.
- count Integer
- The number of nodes in the Node Pool.
- disk
Encryption String - The disk encryption policy for nodes in this pool.
- id Integer
- The LKE Cluster's ID.
- labels Map<String,String>
- Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
- List<String>
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- taints
List<Get
Lke Cluster Pool Taint> - Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
- type String
- The linode type for all of the nodes in the Node Pool. See all node types here.
- autoscalers
List<Get
Lke Cluster Pool Autoscaler> - The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
- disks
List<Get
Lke Cluster Pool Disk> - This Node Pool’s custom disk layout.
- nodes
List<Get
Lke Cluster Pool Node> - The nodes in the Node Pool.
- count number
- The number of nodes in the Node Pool.
- disk
Encryption string - The disk encryption policy for nodes in this pool.
- id number
- The LKE Cluster's ID.
- labels {[key: string]: string}
- Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
- string[]
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- taints
Get
Lke Cluster Pool Taint[] - Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
- type string
- The linode type for all of the nodes in the Node Pool. See all node types here.
- autoscalers
Get
Lke Cluster Pool Autoscaler[] - The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
- disks
Get
Lke Cluster Pool Disk[] - This Node Pool’s custom disk layout.
- nodes
Get
Lke Cluster Pool Node[] - The nodes in the Node Pool.
- count int
- The number of nodes in the Node Pool.
- disk_
encryption str - The disk encryption policy for nodes in this pool.
- id int
- The LKE Cluster's ID.
- labels Mapping[str, str]
- Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
- Sequence[str]
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- taints
Sequence[Get
Lke Cluster Pool Taint] - Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
- type str
- The linode type for all of the nodes in the Node Pool. See all node types here.
- autoscalers
Sequence[Get
Lke Cluster Pool Autoscaler] - The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
- disks
Sequence[Get
Lke Cluster Pool Disk] - This Node Pool’s custom disk layout.
- nodes
Sequence[Get
Lke Cluster Pool Node] - The nodes in the Node Pool.
- count Number
- The number of nodes in the Node Pool.
- disk
Encryption String - The disk encryption policy for nodes in this pool.
- id Number
- The LKE Cluster's ID.
- labels Map<String>
- Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
- List<String>
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- taints List<Property Map>
- Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
- type String
- The linode type for all of the nodes in the Node Pool. See all node types here.
- autoscalers List<Property Map>
- The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
- disks List<Property Map>
- This Node Pool’s custom disk layout.
- nodes List<Property Map>
- The nodes in the Node Pool.
GetLkeClusterPoolAutoscaler
GetLkeClusterPoolDisk
GetLkeClusterPoolNode
- Id string
- The LKE Cluster's ID.
- Instance
Id 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.
- Instance
Id 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.
- instance
Id Integer - The ID of the underlying Linode instance.
- status String
- The status of the node. (
ready
,not_ready
)
- id string
- The LKE Cluster's ID.
- instance
Id 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
)
- id String
- The LKE Cluster's ID.
- instance
Id Number - The ID of the underlying Linode instance.
- status String
- The status of the node. (
ready
,not_ready
)
GetLkeClusterPoolTaint
- Effect string
- The Kubernetes taint effect. The accepted values are
NoSchedule
,PreferNoSchedule
andNoExecute
. For the descriptions of these values, see Kubernetes Taints and Tolerations. - Key string
- The Kubernetes taint key.
- Value string
- The Kubernetes taint value.
- Effect string
- The Kubernetes taint effect. The accepted values are
NoSchedule
,PreferNoSchedule
andNoExecute
. For the descriptions of these values, see Kubernetes Taints and Tolerations. - Key string
- The Kubernetes taint key.
- Value string
- The Kubernetes taint value.
- effect String
- The Kubernetes taint effect. The accepted values are
NoSchedule
,PreferNoSchedule
andNoExecute
. For the descriptions of these values, see Kubernetes Taints and Tolerations. - key String
- The Kubernetes taint key.
- value String
- The Kubernetes taint value.
- effect string
- The Kubernetes taint effect. The accepted values are
NoSchedule
,PreferNoSchedule
andNoExecute
. For the descriptions of these values, see Kubernetes Taints and Tolerations. - key string
- The Kubernetes taint key.
- value string
- The Kubernetes taint value.
- effect str
- The Kubernetes taint effect. The accepted values are
NoSchedule
,PreferNoSchedule
andNoExecute
. For the descriptions of these values, see Kubernetes Taints and Tolerations. - key str
- The Kubernetes taint key.
- value str
- The Kubernetes taint value.
- effect String
- The Kubernetes taint effect. The accepted values are
NoSchedule
,PreferNoSchedule
andNoExecute
. For the descriptions of these values, see Kubernetes Taints and Tolerations. - key String
- The Kubernetes taint key.
- value String
- The Kubernetes taint value.
Package Details
- Repository
- Linode pulumi/pulumi-linode
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
linode
Terraform Provider.