@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
147 lines (146 loc) • 4.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides details about an LKE Cluster.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-lke-cluster).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const my_cluster = linode.getLkeCluster({
* id: 123,
* });
* ```
*/
export declare function getLkeCluster(args: GetLkeClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetLkeClusterResult>;
/**
* A collection of arguments for invoking getLkeCluster.
*/
export interface GetLkeClusterArgs {
/**
* The settings for the Kubernetes Control Plane.
*/
controlPlanes?: inputs.GetLkeClusterControlPlane[];
/**
* The LKE Cluster's ID.
*/
id: number;
/**
* Node pools associated with this cluster.
*/
pools?: inputs.GetLkeClusterPool[];
}
/**
* A collection of values returned by getLkeCluster.
*/
export interface GetLkeClusterResult {
/**
* The endpoints for the Kubernetes API server.
*/
readonly apiEndpoints: string[];
/**
* Enables the App Platform Layer
*/
readonly aplEnabled: boolean;
/**
* The settings for the Kubernetes Control Plane.
*/
readonly controlPlanes?: outputs.GetLkeClusterControlPlane[];
/**
* When this Kubernetes cluster was created.
*/
readonly created: string;
/**
* The Kubernetes Dashboard access URL for this cluster. LKE Enterprise does not have a dashboard URL.
*/
readonly dashboardUrl: string;
/**
* The ID of the node.
*/
readonly id: number;
/**
* The k8s version of the nodes in this Node Pool. For LKE enterprise only and may not currently available to all users even under v4beta.
*/
readonly k8sVersion: string;
/**
* The base64 encoded kubeconfig for the Kubernetes cluster.
*/
readonly kubeconfig: string;
/**
* The label of the Node Pool.
*/
readonly label: string;
/**
* Node pools associated with this cluster.
*/
readonly pools?: outputs.GetLkeClusterPool[];
/**
* This Kubernetes cluster's location.
*/
readonly region: string;
/**
* The networking stack type of the Kubernetes cluster.
*/
readonly stackType: string;
/**
* The status of the node. (`ready`, `notReady`)
*/
readonly status: string;
/**
* The ID of the VPC subnet to use for the Kubernetes cluster. This subnet must be dual stack (IPv4 and IPv6 should both be enabled).
*/
readonly subnetId: number;
/**
* An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
*/
readonly tags: string[];
/**
* The desired Kubernetes tier. (**Note: v4beta only and may not currently be available to all users.**)
*/
readonly tier: string;
/**
* When this Kubernetes cluster was updated.
*/
readonly updated: string;
/**
* The ID of the VPC to use for the Kubernetes cluster.
*/
readonly vpcId: number;
}
/**
* Provides details about an LKE Cluster.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-lke-cluster).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const my_cluster = linode.getLkeCluster({
* id: 123,
* });
* ```
*/
export declare function getLkeClusterOutput(args: GetLkeClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetLkeClusterResult>;
/**
* A collection of arguments for invoking getLkeCluster.
*/
export interface GetLkeClusterOutputArgs {
/**
* The settings for the Kubernetes Control Plane.
*/
controlPlanes?: pulumi.Input<pulumi.Input<inputs.GetLkeClusterControlPlaneArgs>[]>;
/**
* The LKE Cluster's ID.
*/
id: pulumi.Input<number>;
/**
* Node pools associated with this cluster.
*/
pools?: pulumi.Input<pulumi.Input<inputs.GetLkeClusterPoolArgs>[]>;
}