@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
204 lines • 6.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* The `scaleway.kubernetes.Pool` data source is used to retrieve information about a Kubernetes Cluster's Pool.
*
* Refer to the Kubernetes [documentation](https://www.scaleway.com/en/docs/compute/kubernetes/) and [API documentation](https://www.scaleway.com/en/developers/api/kubernetes/) for more information.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by pool id
* const myKey = scaleway.kubernetes.getPool({
* poolId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by pool name (need cluster_id)
* const myKey = scaleway.kubernetes.getPool({
* name: "my-pool-name",
* clusterId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
/** @deprecated scaleway.index/getkubernetesnodepool.getKubernetesNodePool has been deprecated in favor of scaleway.kubernetes/getpool.getPool */
export declare function getKubernetesNodePool(args?: GetKubernetesNodePoolArgs, opts?: pulumi.InvokeOptions): Promise<GetKubernetesNodePoolResult>;
/**
* A collection of arguments for invoking getKubernetesNodePool.
*/
export interface GetKubernetesNodePoolArgs {
/**
* The cluster ID. Required when `name` is set.
*/
clusterId?: string;
/**
* The pool name. Only one of `name` and `poolId` should be specified. `clusterId` should be specified with `name`.
*/
name?: string;
/**
* The pool's ID. Only one of `name` and `poolId` should be specified.
*/
poolId?: string;
/**
* `region`) The region in which the pool exists.
*/
region?: string;
/**
* The size of the pool.
*/
size?: number;
}
/**
* A collection of values returned by getKubernetesNodePool.
*/
export interface GetKubernetesNodePoolResult {
/**
* True if the autohealing feature is enabled for this pool.
*/
readonly autohealing: boolean;
/**
* True if the autoscaling feature is enabled for this pool.
*/
readonly autoscaling: boolean;
readonly clusterId?: string;
/**
* The container runtime of the pool.
*/
readonly containerRuntime: string;
/**
* The creation date of the pool.
*/
readonly createdAt: string;
/**
* The size of the pool at the time the terraform state was updated.
*/
readonly currentSize: number;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly kubeletArgs: {
[key: string]: string;
};
readonly labels: {
[key: string]: string;
};
/**
* The maximum size of the pool, used by the autoscaling feature.
*/
readonly maxSize: number;
/**
* The minimum size of the pool, used by the autoscaling feature.
*/
readonly minSize: number;
/**
* The name of the node.
*/
readonly name?: string;
/**
* The commercial type of the pool instances.
*/
readonly nodeType: string;
/**
* (List of) The nodes in the default pool.
*/
readonly nodes: outputs.GetKubernetesNodePoolNode[];
/**
* [placement group](https://developers.scaleway.com/en/products/instance/api/#placement-groups-d8f653) the nodes of the pool are attached to.
*/
readonly placementGroupId: string;
readonly poolId?: string;
readonly publicIpDisabled: boolean;
readonly region?: string;
readonly rootVolumeSizeInGb: number;
readonly rootVolumeType: string;
readonly securityGroupId: string;
/**
* The size of the pool.
*/
readonly size?: number;
readonly startupTaints: outputs.GetKubernetesNodePoolStartupTaint[];
/**
* The status of the node.
*/
readonly status: string;
/**
* The tags associated with the pool.
*/
readonly tags: string[];
readonly taints: outputs.GetKubernetesNodePoolTaint[];
/**
* The last update date of the pool.
*/
readonly updatedAt: string;
readonly upgradePolicies: outputs.GetKubernetesNodePoolUpgradePolicy[];
/**
* The version of the pool.
*/
readonly version: string;
readonly waitForPoolReady: boolean;
readonly zone: string;
}
/**
* The `scaleway.kubernetes.Pool` data source is used to retrieve information about a Kubernetes Cluster's Pool.
*
* Refer to the Kubernetes [documentation](https://www.scaleway.com/en/docs/compute/kubernetes/) and [API documentation](https://www.scaleway.com/en/developers/api/kubernetes/) for more information.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by pool id
* const myKey = scaleway.kubernetes.getPool({
* poolId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by pool name (need cluster_id)
* const myKey = scaleway.kubernetes.getPool({
* name: "my-pool-name",
* clusterId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
/** @deprecated scaleway.index/getkubernetesnodepool.getKubernetesNodePool has been deprecated in favor of scaleway.kubernetes/getpool.getPool */
export declare function getKubernetesNodePoolOutput(args?: GetKubernetesNodePoolOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetKubernetesNodePoolResult>;
/**
* A collection of arguments for invoking getKubernetesNodePool.
*/
export interface GetKubernetesNodePoolOutputArgs {
/**
* The cluster ID. Required when `name` is set.
*/
clusterId?: pulumi.Input<string | undefined>;
/**
* The pool name. Only one of `name` and `poolId` should be specified. `clusterId` should be specified with `name`.
*/
name?: pulumi.Input<string | undefined>;
/**
* The pool's ID. Only one of `name` and `poolId` should be specified.
*/
poolId?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the pool exists.
*/
region?: pulumi.Input<string | undefined>;
/**
* The size of the pool.
*/
size?: pulumi.Input<number | undefined>;
}
//# sourceMappingURL=getKubernetesNodePool.d.ts.map