ionoscloud.getK8sNodePool
Explore with Pulumi AI
The k8s Node Pool data source can be used to search for and return existing k8s Node Pools. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.
Example Usage
By ID
import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";
const example = ionoscloud.getK8sNodePool({
id: "k8s_nodepool_id",
k8sClusterId: "k8s_cluster_id",
});
import pulumi
import pulumi_ionoscloud as ionoscloud
example = ionoscloud.get_k8s_node_pool(id="k8s_nodepool_id",
k8s_cluster_id="k8s_cluster_id")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ionoscloud/v6/ionoscloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ionoscloud.LookupK8sNodePool(ctx, &ionoscloud.LookupK8sNodePoolArgs{
Id: pulumi.StringRef("k8s_nodepool_id"),
K8sClusterId: "k8s_cluster_id",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ionoscloud = Pulumi.Ionoscloud;
return await Deployment.RunAsync(() =>
{
var example = Ionoscloud.GetK8sNodePool.Invoke(new()
{
Id = "k8s_nodepool_id",
K8sClusterId = "k8s_cluster_id",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.IonoscloudFunctions;
import com.pulumi.ionoscloud.inputs.GetK8sNodePoolArgs;
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 example = IonoscloudFunctions.getK8sNodePool(GetK8sNodePoolArgs.builder()
.id("k8s_nodepool_id")
.k8sClusterId("k8s_cluster_id")
.build());
}
}
variables:
example:
fn::invoke:
function: ionoscloud:getK8sNodePool
arguments:
id: k8s_nodepool_id
k8sClusterId: k8s_cluster_id
By Name
import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";
const example = ionoscloud.getK8sNodePool({
k8sClusterId: "k8s_cluster_id",
name: "k8s NodePool Example",
});
import pulumi
import pulumi_ionoscloud as ionoscloud
example = ionoscloud.get_k8s_node_pool(k8s_cluster_id="k8s_cluster_id",
name="k8s NodePool Example")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ionoscloud/v6/ionoscloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ionoscloud.LookupK8sNodePool(ctx, &ionoscloud.LookupK8sNodePoolArgs{
K8sClusterId: "k8s_cluster_id",
Name: pulumi.StringRef("k8s NodePool Example"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ionoscloud = Pulumi.Ionoscloud;
return await Deployment.RunAsync(() =>
{
var example = Ionoscloud.GetK8sNodePool.Invoke(new()
{
K8sClusterId = "k8s_cluster_id",
Name = "k8s NodePool Example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.IonoscloudFunctions;
import com.pulumi.ionoscloud.inputs.GetK8sNodePoolArgs;
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 example = IonoscloudFunctions.getK8sNodePool(GetK8sNodePoolArgs.builder()
.k8sClusterId("k8s_cluster_id")
.name("k8s NodePool Example")
.build());
}
}
variables:
example:
fn::invoke:
function: ionoscloud:getK8sNodePool
arguments:
k8sClusterId: k8s_cluster_id
name: k8s NodePool Example
Using getK8sNodePool
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 getK8sNodePool(args: GetK8sNodePoolArgs, opts?: InvokeOptions): Promise<GetK8sNodePoolResult>
function getK8sNodePoolOutput(args: GetK8sNodePoolOutputArgs, opts?: InvokeOptions): Output<GetK8sNodePoolResult>
def get_k8s_node_pool(id: Optional[str] = None,
k8s_cluster_id: Optional[str] = None,
name: Optional[str] = None,
timeouts: Optional[GetK8sNodePoolTimeouts] = None,
opts: Optional[InvokeOptions] = None) -> GetK8sNodePoolResult
def get_k8s_node_pool_output(id: Optional[pulumi.Input[str]] = None,
k8s_cluster_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
timeouts: Optional[pulumi.Input[GetK8sNodePoolTimeoutsArgs]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetK8sNodePoolResult]
func LookupK8sNodePool(ctx *Context, args *LookupK8sNodePoolArgs, opts ...InvokeOption) (*LookupK8sNodePoolResult, error)
func LookupK8sNodePoolOutput(ctx *Context, args *LookupK8sNodePoolOutputArgs, opts ...InvokeOption) LookupK8sNodePoolResultOutput
> Note: This function is named LookupK8sNodePool
in the Go SDK.
public static class GetK8sNodePool
{
public static Task<GetK8sNodePoolResult> InvokeAsync(GetK8sNodePoolArgs args, InvokeOptions? opts = null)
public static Output<GetK8sNodePoolResult> Invoke(GetK8sNodePoolInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetK8sNodePoolResult> getK8sNodePool(GetK8sNodePoolArgs args, InvokeOptions options)
public static Output<GetK8sNodePoolResult> getK8sNodePool(GetK8sNodePoolArgs args, InvokeOptions options)
fn::invoke:
function: ionoscloud:index/getK8sNodePool:getK8sNodePool
arguments:
# arguments dictionary
The following arguments are supported:
- K8s
Cluster stringId - K8s Cluster' UUID
- Id string
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- Name string
- Name of an existing node pool that you want to search for.
- Timeouts
Get
K8s Node Pool Timeouts
- K8s
Cluster stringId - K8s Cluster' UUID
- Id string
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- Name string
- Name of an existing node pool that you want to search for.
- Timeouts
Get
K8s Node Pool Timeouts
- k8s
Cluster StringId - K8s Cluster' UUID
- id String
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- name String
- Name of an existing node pool that you want to search for.
- timeouts
Get
K8s Node Pool Timeouts
- k8s
Cluster stringId - K8s Cluster' UUID
- id string
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- name string
- Name of an existing node pool that you want to search for.
- timeouts
Get
K8s Node Pool Timeouts
- k8s_
cluster_ strid - K8s Cluster' UUID
- id str
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- name str
- Name of an existing node pool that you want to search for.
- timeouts
Get
K8s Node Pool Timeouts
- k8s
Cluster StringId - K8s Cluster' UUID
- id String
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- name String
- Name of an existing node pool that you want to search for.
- timeouts Property Map
getK8sNodePool Result
The following output properties are available:
- Annotations Dictionary<string, string>
- A map of annotations in the form of key > value
- Auto
Scalings List<GetK8s Node Pool Auto Scaling> - The range defining the minimum and maximum number of worker nodes that the managed node group can scale in
- Availability
Zone string - The compute availability zone in which the nodes should exist
- Available
Upgrade List<string>Versions - A list of kubernetes versions available for upgrade
- Cores
Count double - CPU cores count
- Cpu
Family string - CPU Family
- Datacenter
Id string - The UUID of the VDC
- Id string
- The LAN ID of an existing LAN at the related datacenter
- K8s
Cluster stringId - ID of the cluster this node pool is part of
- K8s
Version string - The kubernetes version
- Labels Dictionary<string, string>
- A map of labels in the form of key > value
- Lans
List<Get
K8s Node Pool Lan> - A list of Local Area Networks the node pool is a part of
- Maintenance
Windows List<GetK8s Node Pool Maintenance Window> - A maintenance window comprise of a day of the week and a time for maintenance to be allowed
- Name string
- name of the node pool
- Node
Count double - The number of nodes in this node pool
- Public
Ips List<string> - The list of fixed IPs associated with this node pool
- Ram
Size double - The amount of RAM in MB
- Server
Type string - The server type for the compute engine
- State string
- one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"
- Storage
Size double - The size of the volume in GB. The size should be greater than 10GB.
- Storage
Type string - HDD or SDD
- Timeouts
Get
K8s Node Pool Timeouts
- Annotations map[string]string
- A map of annotations in the form of key > value
- Auto
Scalings []GetK8s Node Pool Auto Scaling - The range defining the minimum and maximum number of worker nodes that the managed node group can scale in
- Availability
Zone string - The compute availability zone in which the nodes should exist
- Available
Upgrade []stringVersions - A list of kubernetes versions available for upgrade
- Cores
Count float64 - CPU cores count
- Cpu
Family string - CPU Family
- Datacenter
Id string - The UUID of the VDC
- Id string
- The LAN ID of an existing LAN at the related datacenter
- K8s
Cluster stringId - ID of the cluster this node pool is part of
- K8s
Version string - The kubernetes version
- Labels map[string]string
- A map of labels in the form of key > value
- Lans
[]Get
K8s Node Pool Lan - A list of Local Area Networks the node pool is a part of
- Maintenance
Windows []GetK8s Node Pool Maintenance Window - A maintenance window comprise of a day of the week and a time for maintenance to be allowed
- Name string
- name of the node pool
- Node
Count float64 - The number of nodes in this node pool
- Public
Ips []string - The list of fixed IPs associated with this node pool
- Ram
Size float64 - The amount of RAM in MB
- Server
Type string - The server type for the compute engine
- State string
- one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"
- Storage
Size float64 - The size of the volume in GB. The size should be greater than 10GB.
- Storage
Type string - HDD or SDD
- Timeouts
Get
K8s Node Pool Timeouts
- annotations Map<String,String>
- A map of annotations in the form of key > value
- auto
Scalings List<GetK8s Node Pool Auto Scaling> - The range defining the minimum and maximum number of worker nodes that the managed node group can scale in
- availability
Zone String - The compute availability zone in which the nodes should exist
- available
Upgrade List<String>Versions - A list of kubernetes versions available for upgrade
- cores
Count Double - CPU cores count
- cpu
Family String - CPU Family
- datacenter
Id String - The UUID of the VDC
- id String
- The LAN ID of an existing LAN at the related datacenter
- k8s
Cluster StringId - ID of the cluster this node pool is part of
- k8s
Version String - The kubernetes version
- labels Map<String,String>
- A map of labels in the form of key > value
- lans
List<Get
K8s Node Pool Lan> - A list of Local Area Networks the node pool is a part of
- maintenance
Windows List<GetK8s Node Pool Maintenance Window> - A maintenance window comprise of a day of the week and a time for maintenance to be allowed
- name String
- name of the node pool
- node
Count Double - The number of nodes in this node pool
- public
Ips List<String> - The list of fixed IPs associated with this node pool
- ram
Size Double - The amount of RAM in MB
- server
Type String - The server type for the compute engine
- state String
- one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"
- storage
Size Double - The size of the volume in GB. The size should be greater than 10GB.
- storage
Type String - HDD or SDD
- timeouts
Get
K8s Node Pool Timeouts
- annotations {[key: string]: string}
- A map of annotations in the form of key > value
- auto
Scalings GetK8s Node Pool Auto Scaling[] - The range defining the minimum and maximum number of worker nodes that the managed node group can scale in
- availability
Zone string - The compute availability zone in which the nodes should exist
- available
Upgrade string[]Versions - A list of kubernetes versions available for upgrade
- cores
Count number - CPU cores count
- cpu
Family string - CPU Family
- datacenter
Id string - The UUID of the VDC
- id string
- The LAN ID of an existing LAN at the related datacenter
- k8s
Cluster stringId - ID of the cluster this node pool is part of
- k8s
Version string - The kubernetes version
- labels {[key: string]: string}
- A map of labels in the form of key > value
- lans
Get
K8s Node Pool Lan[] - A list of Local Area Networks the node pool is a part of
- maintenance
Windows GetK8s Node Pool Maintenance Window[] - A maintenance window comprise of a day of the week and a time for maintenance to be allowed
- name string
- name of the node pool
- node
Count number - The number of nodes in this node pool
- public
Ips string[] - The list of fixed IPs associated with this node pool
- ram
Size number - The amount of RAM in MB
- server
Type string - The server type for the compute engine
- state string
- one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"
- storage
Size number - The size of the volume in GB. The size should be greater than 10GB.
- storage
Type string - HDD or SDD
- timeouts
Get
K8s Node Pool Timeouts
- annotations Mapping[str, str]
- A map of annotations in the form of key > value
- auto_
scalings Sequence[GetK8s Node Pool Auto Scaling] - The range defining the minimum and maximum number of worker nodes that the managed node group can scale in
- availability_
zone str - The compute availability zone in which the nodes should exist
- available_
upgrade_ Sequence[str]versions - A list of kubernetes versions available for upgrade
- cores_
count float - CPU cores count
- cpu_
family str - CPU Family
- datacenter_
id str - The UUID of the VDC
- id str
- The LAN ID of an existing LAN at the related datacenter
- k8s_
cluster_ strid - ID of the cluster this node pool is part of
- k8s_
version str - The kubernetes version
- labels Mapping[str, str]
- A map of labels in the form of key > value
- lans
Sequence[Get
K8s Node Pool Lan] - A list of Local Area Networks the node pool is a part of
- maintenance_
windows Sequence[GetK8s Node Pool Maintenance Window] - A maintenance window comprise of a day of the week and a time for maintenance to be allowed
- name str
- name of the node pool
- node_
count float - The number of nodes in this node pool
- public_
ips Sequence[str] - The list of fixed IPs associated with this node pool
- ram_
size float - The amount of RAM in MB
- server_
type str - The server type for the compute engine
- state str
- one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"
- storage_
size float - The size of the volume in GB. The size should be greater than 10GB.
- storage_
type str - HDD or SDD
- timeouts
Get
K8s Node Pool Timeouts
- annotations Map<String>
- A map of annotations in the form of key > value
- auto
Scalings List<Property Map> - The range defining the minimum and maximum number of worker nodes that the managed node group can scale in
- availability
Zone String - The compute availability zone in which the nodes should exist
- available
Upgrade List<String>Versions - A list of kubernetes versions available for upgrade
- cores
Count Number - CPU cores count
- cpu
Family String - CPU Family
- datacenter
Id String - The UUID of the VDC
- id String
- The LAN ID of an existing LAN at the related datacenter
- k8s
Cluster StringId - ID of the cluster this node pool is part of
- k8s
Version String - The kubernetes version
- labels Map<String>
- A map of labels in the form of key > value
- lans List<Property Map>
- A list of Local Area Networks the node pool is a part of
- maintenance
Windows List<Property Map> - A maintenance window comprise of a day of the week and a time for maintenance to be allowed
- name String
- name of the node pool
- node
Count Number - The number of nodes in this node pool
- public
Ips List<String> - The list of fixed IPs associated with this node pool
- ram
Size Number - The amount of RAM in MB
- server
Type String - The server type for the compute engine
- state String
- one of "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED"
- storage
Size Number - The size of the volume in GB. The size should be greater than 10GB.
- storage
Type String - HDD or SDD
- timeouts Property Map
Supporting Types
GetK8sNodePoolAutoScaling
- Max
Node doubleCount - The maximum number of worker nodes that the node pool can scale to
- Min
Node doubleCount - The minimum number of worker nodes the node pool can scale down to
- Max
Node float64Count - The maximum number of worker nodes that the node pool can scale to
- Min
Node float64Count - The minimum number of worker nodes the node pool can scale down to
- max
Node DoubleCount - The maximum number of worker nodes that the node pool can scale to
- min
Node DoubleCount - The minimum number of worker nodes the node pool can scale down to
- max
Node numberCount - The maximum number of worker nodes that the node pool can scale to
- min
Node numberCount - The minimum number of worker nodes the node pool can scale down to
- max_
node_ floatcount - The maximum number of worker nodes that the node pool can scale to
- min_
node_ floatcount - The minimum number of worker nodes the node pool can scale down to
- max
Node NumberCount - The maximum number of worker nodes that the node pool can scale to
- min
Node NumberCount - The minimum number of worker nodes the node pool can scale down to
GetK8sNodePoolLan
- Dhcp bool
- Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP
- Id double
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- Routes
List<Get
K8s Node Pool Lan Route> - An array of additional LANs attached to worker nodes
- Dhcp bool
- Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP
- Id float64
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- Routes
[]Get
K8s Node Pool Lan Route - An array of additional LANs attached to worker nodes
- dhcp Boolean
- Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP
- id Double
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- routes
List<Get
K8s Node Pool Lan Route> - An array of additional LANs attached to worker nodes
- dhcp boolean
- Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP
- id number
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- routes
Get
K8s Node Pool Lan Route[] - An array of additional LANs attached to worker nodes
- dhcp bool
- Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP
- id float
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- routes
Sequence[Get
K8s Node Pool Lan Route] - An array of additional LANs attached to worker nodes
- dhcp Boolean
- Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP
- id Number
ID of the node pool you want to search for.
k8s_cluster_id
and eithername
orid
must be provided. If none, or both ofname
andid
are provided, the datasource will return an error.- routes List<Property Map>
- An array of additional LANs attached to worker nodes
GetK8sNodePoolLanRoute
- gateway_
ip str - IPv4 or IPv6 Gateway IP for the route
- network str
- IPv4 or IPv6 CIDR to be routed via the interface
GetK8sNodePoolMaintenanceWindow
- Day
Of stringThe Week - Day of the week when maintenance is allowed
- Time string
- A clock time in the day when maintenance is allowed
- Day
Of stringThe Week - Day of the week when maintenance is allowed
- Time string
- A clock time in the day when maintenance is allowed
- day
Of StringThe Week - Day of the week when maintenance is allowed
- time String
- A clock time in the day when maintenance is allowed
- day
Of stringThe Week - Day of the week when maintenance is allowed
- time string
- A clock time in the day when maintenance is allowed
- day_
of_ strthe_ week - Day of the week when maintenance is allowed
- time str
- A clock time in the day when maintenance is allowed
- day
Of StringThe Week - Day of the week when maintenance is allowed
- time String
- A clock time in the day when maintenance is allowed
GetK8sNodePoolTimeouts
Package Details
- Repository
- ionoscloud ionos-cloud/terraform-provider-ionoscloud
- License
- Notes
- This Pulumi package is based on the
ionoscloud
Terraform Provider.