@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
161 lines (160 loc) • 6.51 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Retrieves information about a DigitalOcean Kubernetes cluster for use in other resources. This data source provides all of the cluster's properties as configured on your DigitalOcean account. This is useful if the cluster in question is not managed by the provider.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = digitalocean.getKubernetesCluster({
* name: "prod-cluster-01",
* });
* ```
*/
export declare function getKubernetesCluster(args: GetKubernetesClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetKubernetesClusterResult>;
/**
* A collection of arguments for invoking getKubernetesCluster.
*/
export interface GetKubernetesClusterArgs {
amdGpuDeviceMetricsExporterPlugin?: inputs.GetKubernetesClusterAmdGpuDeviceMetricsExporterPlugin;
amdGpuDevicePlugin?: inputs.GetKubernetesClusterAmdGpuDevicePlugin;
clusterAutoscalerConfigurations?: inputs.GetKubernetesClusterClusterAutoscalerConfiguration[];
kubeconfigExpireSeconds?: number;
/**
* The name of Kubernetes cluster.
*/
name: string;
nvidiaGpuDevicePlugin?: inputs.GetKubernetesClusterNvidiaGpuDevicePlugin;
rdmaSharedDevicePlugin?: inputs.GetKubernetesClusterRdmaSharedDevicePlugin;
routingAgent?: inputs.GetKubernetesClusterRoutingAgent;
/**
* A list of tag names applied to the node pool.
*/
tags?: string[];
}
/**
* A collection of values returned by getKubernetesCluster.
*/
export interface GetKubernetesClusterResult {
readonly amdGpuDeviceMetricsExporterPlugin: outputs.GetKubernetesClusterAmdGpuDeviceMetricsExporterPlugin;
readonly amdGpuDevicePlugin: outputs.GetKubernetesClusterAmdGpuDevicePlugin;
/**
* A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
*/
readonly autoUpgrade: boolean;
readonly clusterAutoscalerConfigurations?: outputs.GetKubernetesClusterClusterAutoscalerConfiguration[];
/**
* The range of IP addresses in the overlay network of the Kubernetes cluster.
*/
readonly clusterSubnet: string;
readonly controlPlaneFirewalls: outputs.GetKubernetesClusterControlPlaneFirewall[];
/**
* The date and time when the node was created.
*/
readonly createdAt: string;
/**
* The base URL of the API server on the Kubernetes master node.
*/
readonly endpoint: string;
readonly ha: boolean;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The public IPv4 address of the Kubernetes master node.
*/
readonly ipv4Address: string;
/**
* A representation of the Kubernetes cluster's kubeconfig with the following attributes:
*/
readonly kubeConfigs: outputs.GetKubernetesClusterKubeConfig[];
readonly kubeconfigExpireSeconds?: number;
/**
* The maintenance policy of the Kubernetes cluster. Digital Ocean has a default maintenancen window.
*/
readonly maintenancePolicies: outputs.GetKubernetesClusterMaintenancePolicy[];
/**
* The auto-generated name for the node.
*/
readonly name: string;
/**
* A list of node pools associated with the cluster. Each node pool exports the following attributes:
*/
readonly nodePools: outputs.GetKubernetesClusterNodePool[];
readonly nvidiaGpuDevicePlugin: outputs.GetKubernetesClusterNvidiaGpuDevicePlugin;
readonly rdmaSharedDevicePlugin: outputs.GetKubernetesClusterRdmaSharedDevicePlugin;
/**
* The slug identifier for the region where the Kubernetes cluster is located.
*/
readonly region: string;
readonly routingAgent: outputs.GetKubernetesClusterRoutingAgent;
/**
* The range of assignable IP addresses for services running in the Kubernetes cluster.
*/
readonly serviceSubnet: string;
/**
* A string indicating the current status of the individual node.
*/
readonly status: string;
readonly surgeUpgrade: boolean;
/**
* A list of tag names applied to the node pool.
*/
readonly tags?: string[];
/**
* The date and time when the node was last updated.
*/
readonly updatedAt: string;
/**
* The uniform resource name (URN) for the Kubernetes cluster.
*/
readonly urn: string;
/**
* The slug identifier for the version of Kubernetes used for the cluster.
*/
readonly version: string;
/**
* The ID of the VPC where the Kubernetes cluster is located.
*/
readonly vpcUuid: string;
}
/**
* Retrieves information about a DigitalOcean Kubernetes cluster for use in other resources. This data source provides all of the cluster's properties as configured on your DigitalOcean account. This is useful if the cluster in question is not managed by the provider.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = digitalocean.getKubernetesCluster({
* name: "prod-cluster-01",
* });
* ```
*/
export declare function getKubernetesClusterOutput(args: GetKubernetesClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetKubernetesClusterResult>;
/**
* A collection of arguments for invoking getKubernetesCluster.
*/
export interface GetKubernetesClusterOutputArgs {
amdGpuDeviceMetricsExporterPlugin?: pulumi.Input<inputs.GetKubernetesClusterAmdGpuDeviceMetricsExporterPluginArgs>;
amdGpuDevicePlugin?: pulumi.Input<inputs.GetKubernetesClusterAmdGpuDevicePluginArgs>;
clusterAutoscalerConfigurations?: pulumi.Input<pulumi.Input<inputs.GetKubernetesClusterClusterAutoscalerConfigurationArgs>[]>;
kubeconfigExpireSeconds?: pulumi.Input<number>;
/**
* The name of Kubernetes cluster.
*/
name: pulumi.Input<string>;
nvidiaGpuDevicePlugin?: pulumi.Input<inputs.GetKubernetesClusterNvidiaGpuDevicePluginArgs>;
rdmaSharedDevicePlugin?: pulumi.Input<inputs.GetKubernetesClusterRdmaSharedDevicePluginArgs>;
routingAgent?: pulumi.Input<inputs.GetKubernetesClusterRoutingAgentArgs>;
/**
* A list of tag names applied to the node pool.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}