1. Packages
  2. Linode
  3. API Docs
  4. getLkeCluster
Linode v4.23.0 published on Thursday, Jul 18, 2024 by Pulumi

linode.getLkeCluster

Explore with Pulumi AI

linode logo
Linode v4.23.0 published on Thursday, Jul 18, 2024 by Pulumi

    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.
    ControlPlanes List<GetLkeClusterControlPlane>
    The settings for the Kubernetes Control Plane.
    Pools List<GetLkeClusterPool>
    Node pools associated with this cluster.
    Id int
    The LKE Cluster's ID.
    ControlPlanes []GetLkeClusterControlPlane
    The settings for the Kubernetes Control Plane.
    Pools []GetLkeClusterPool
    Node pools associated with this cluster.
    id Integer
    The LKE Cluster's ID.
    controlPlanes List<GetLkeClusterControlPlane>
    The settings for the Kubernetes Control Plane.
    pools List<GetLkeClusterPool>
    Node pools associated with this cluster.
    id number
    The LKE Cluster's ID.
    controlPlanes GetLkeClusterControlPlane[]
    The settings for the Kubernetes Control Plane.
    pools GetLkeClusterPool[]
    Node pools associated with this cluster.
    id int
    The LKE Cluster's ID.
    control_planes Sequence[GetLkeClusterControlPlane]
    The settings for the Kubernetes Control Plane.
    pools Sequence[GetLkeClusterPool]
    Node pools associated with this cluster.
    id Number
    The LKE Cluster's ID.
    controlPlanes 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:

    ApiEndpoints List<string>
    The endpoints for the Kubernetes API server.
    Created string
    When this Kubernetes cluster was created.
    DashboardUrl string
    The Kubernetes Dashboard access URL for this cluster.
    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
    The unique label for the cluster.
    Region string
    This Kubernetes cluster's location.
    Status string
    The status of the node. (ready, not_ready)
    Tags 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.
    ControlPlanes List<GetLkeClusterControlPlane>
    The settings for the Kubernetes Control Plane.
    Pools List<GetLkeClusterPool>
    Node pools associated with this cluster.
    ApiEndpoints []string
    The endpoints for the Kubernetes API server.
    Created string
    When this Kubernetes cluster was created.
    DashboardUrl string
    The Kubernetes Dashboard access URL for this cluster.
    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
    The unique label for the cluster.
    Region string
    This Kubernetes cluster's location.
    Status string
    The status of the node. (ready, not_ready)
    Tags []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.
    ControlPlanes []GetLkeClusterControlPlane
    The settings for the Kubernetes Control Plane.
    Pools []GetLkeClusterPool
    Node pools associated with this cluster.
    apiEndpoints List<String>
    The endpoints for the Kubernetes API server.
    created String
    When this Kubernetes cluster was created.
    dashboardUrl String
    The Kubernetes Dashboard access URL for this cluster.
    id Integer
    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
    The unique label for the cluster.
    region String
    This Kubernetes cluster's location.
    status String
    The status of the node. (ready, not_ready)
    tags 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.
    controlPlanes List<GetLkeClusterControlPlane>
    The settings for the Kubernetes Control Plane.
    pools List<GetLkeClusterPool>
    Node pools associated with this cluster.
    apiEndpoints string[]
    The endpoints for the Kubernetes API server.
    created string
    When this Kubernetes cluster was created.
    dashboardUrl string
    The Kubernetes Dashboard access URL for this cluster.
    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
    The unique label for the cluster.
    region string
    This Kubernetes cluster's location.
    status string
    The status of the node. (ready, not_ready)
    tags 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.
    controlPlanes GetLkeClusterControlPlane[]
    The settings for the Kubernetes Control Plane.
    pools GetLkeClusterPool[]
    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)
    tags 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[GetLkeClusterControlPlane]
    The settings for the Kubernetes Control Plane.
    pools Sequence[GetLkeClusterPool]
    Node pools associated with this cluster.
    apiEndpoints List<String>
    The endpoints for the Kubernetes API server.
    created String
    When this Kubernetes cluster was created.
    dashboardUrl String
    The Kubernetes Dashboard access URL for this cluster.
    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
    The unique label for the cluster.
    region String
    This Kubernetes cluster's location.
    status String
    The status of the node. (ready, not_ready)
    tags 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.
    controlPlanes List<Property Map>
    The settings for the Kubernetes Control Plane.
    pools List<Property Map>
    Node pools associated with this cluster.

    Supporting Types

    GetLkeClusterControlPlane

    HighAvailability bool
    Whether High Availability is enabled for the cluster Control Plane.
    Acls List<GetLkeClusterControlPlaneAcl>
    The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
    HighAvailability bool
    Whether High Availability is enabled for the cluster Control Plane.
    Acls []GetLkeClusterControlPlaneAcl
    The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
    highAvailability Boolean
    Whether High Availability is enabled for the cluster Control Plane.
    acls List<GetLkeClusterControlPlaneAcl>
    The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
    highAvailability boolean
    Whether High Availability is enabled for the cluster Control Plane.
    acls GetLkeClusterControlPlaneAcl[]
    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[GetLkeClusterControlPlaneAcl]
    The ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
    highAvailability 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<GetLkeClusterControlPlaneAclAddress>
    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 []GetLkeClusterControlPlaneAclAddress
    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<GetLkeClusterControlPlaneAclAddress>
    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 GetLkeClusterControlPlaneAclAddress[]
    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[GetLkeClusterControlPlaneAclAddress]
    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

    Ipv4s List<string>
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    Ipv6s List<string>
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    Ipv4s []string
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    Ipv6s []string
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    ipv4s List<String>
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    ipv6s List<String>
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    ipv4s string[]
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    ipv6s string[]
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    ipv4s Sequence[str]
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    ipv6s Sequence[str]
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    ipv4s List<String>
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    ipv6s List<String>
    A set of individual ipv6 addresses or CIDRs to ALLOW.

    GetLkeClusterPool

    Count int
    The number of nodes in the Node Pool.
    Id int
    The LKE Cluster's ID.
    Tags List<string>
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    Type string
    This custom disk partition’s filesystem type.
    Autoscalers List<GetLkeClusterPoolAutoscaler>
    The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
    Disks List<GetLkeClusterPoolDisk>
    This Node Pool’s custom disk layout.
    Nodes List<GetLkeClusterPoolNode>
    The nodes in the Node Pool.
    Count int
    The number of nodes in the Node Pool.
    Id int
    The LKE Cluster's ID.
    Tags []string
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    Type string
    This custom disk partition’s filesystem type.
    Autoscalers []GetLkeClusterPoolAutoscaler
    The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
    Disks []GetLkeClusterPoolDisk
    This Node Pool’s custom disk layout.
    Nodes []GetLkeClusterPoolNode
    The nodes in the Node Pool.
    count Integer
    The number of nodes in the Node Pool.
    id Integer
    The LKE Cluster's ID.
    tags List<String>
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    type String
    This custom disk partition’s filesystem type.
    autoscalers List<GetLkeClusterPoolAutoscaler>
    The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
    disks List<GetLkeClusterPoolDisk>
    This Node Pool’s custom disk layout.
    nodes List<GetLkeClusterPoolNode>
    The nodes in the Node Pool.
    count number
    The number of nodes in the Node Pool.
    id number
    The LKE Cluster's ID.
    tags string[]
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    type string
    This custom disk partition’s filesystem type.
    autoscalers GetLkeClusterPoolAutoscaler[]
    The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
    disks GetLkeClusterPoolDisk[]
    This Node Pool’s custom disk layout.
    nodes GetLkeClusterPoolNode[]
    The nodes in the Node Pool.
    count int
    The number of nodes in the Node Pool.
    id int
    The LKE Cluster's ID.
    tags Sequence[str]
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    type str
    This custom disk partition’s filesystem type.
    autoscalers Sequence[GetLkeClusterPoolAutoscaler]
    The configuration options for the autoscaler. This field only contains an autoscaler configuration if autoscaling is enabled on this cluster.
    disks Sequence[GetLkeClusterPoolDisk]
    This Node Pool’s custom disk layout.
    nodes Sequence[GetLkeClusterPoolNode]
    The nodes in the Node Pool.
    count Number
    The number of nodes in the Node Pool.
    id Number
    The LKE Cluster's ID.
    tags List<String>
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    type String
    This custom disk partition’s filesystem type.
    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

    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.
    Max int
    The maximum number of nodes to autoscale to.
    Min int
    The minimum number of nodes to autoscale to.
    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.
    Max int
    The maximum number of nodes to autoscale to.
    Min int
    The minimum number of nodes to autoscale to.
    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.
    max Integer
    The maximum number of nodes to autoscale to.
    min Integer
    The minimum number of nodes to autoscale to.
    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.
    max number
    The maximum number of nodes to autoscale to.
    min number
    The minimum number of nodes to autoscale to.
    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.
    max int
    The maximum number of nodes to autoscale to.
    min int
    The minimum number of nodes to autoscale to.
    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.
    max Number
    The maximum number of nodes to autoscale to.
    min Number
    The minimum number of nodes to autoscale to.

    GetLkeClusterPoolDisk

    Size int
    The size of this custom disk partition in MB.
    Type string
    This custom disk partition’s filesystem type.
    Size int
    The size of this custom disk partition in MB.
    Type string
    This custom disk partition’s filesystem type.
    size Integer
    The size of this custom disk partition in MB.
    type String
    This custom disk partition’s filesystem type.
    size number
    The size of this custom disk partition in MB.
    type string
    This custom disk partition’s filesystem type.
    size int
    The size of this custom disk partition in MB.
    type str
    This custom disk partition’s filesystem type.
    size Number
    The size of this custom disk partition in MB.
    type String
    This custom disk partition’s filesystem type.

    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 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.
    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)
    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)

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.23.0 published on Thursday, Jul 18, 2024 by Pulumi