published on Wednesday, Apr 15, 2026 by ionos-cloud
published on Wednesday, Apr 15, 2026 by ionos-cloud
Manages a Managed Kubernetes Node Pool, part of a managed Kubernetes cluster on IonosCloud.
Create NodePool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NodePool(name: string, args: NodePoolArgs, opts?: CustomResourceOptions);@overload
def NodePool(resource_name: str,
args: NodePoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NodePool(resource_name: str,
opts: Optional[ResourceOptions] = None,
node_count: Optional[int] = None,
storage_type: Optional[str] = None,
storage_size: Optional[int] = None,
availability_zone: Optional[str] = None,
cores_count: Optional[int] = None,
ram_size: Optional[int] = None,
datacenter_id: Optional[str] = None,
k8s_cluster_id: Optional[str] = None,
k8s_version: Optional[str] = None,
lans: Optional[Sequence[NodePoolLanArgs]] = None,
allow_replace: Optional[bool] = None,
location: Optional[str] = None,
maintenance_window: Optional[NodePoolMaintenanceWindowArgs] = None,
name: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
public_ips: Optional[Sequence[str]] = None,
cpu_family: Optional[str] = None,
server_type: Optional[str] = None,
auto_scaling: Optional[NodePoolAutoScalingArgs] = None,
annotations: Optional[Mapping[str, str]] = None)func NewNodePool(ctx *Context, name string, args NodePoolArgs, opts ...ResourceOption) (*NodePool, error)public NodePool(string name, NodePoolArgs args, CustomResourceOptions? opts = null)
public NodePool(String name, NodePoolArgs args)
public NodePool(String name, NodePoolArgs args, CustomResourceOptions options)
type: ionoscloud:k8s:NodePool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var nodePoolResource = new Ionoscloud.K8s.NodePool("nodePoolResource", new()
{
NodeCount = 0,
StorageType = "string",
StorageSize = 0,
AvailabilityZone = "string",
CoresCount = 0,
RamSize = 0,
DatacenterId = "string",
K8sClusterId = "string",
K8sVersion = "string",
Lans = new[]
{
new Ionoscloud.K8s.Inputs.NodePoolLanArgs
{
Id = 0,
Dhcp = false,
Routes = new[]
{
new Ionoscloud.K8s.Inputs.NodePoolLanRouteArgs
{
GatewayIp = "string",
Network = "string",
},
},
},
},
AllowReplace = false,
Location = "string",
MaintenanceWindow = new Ionoscloud.K8s.Inputs.NodePoolMaintenanceWindowArgs
{
DayOfTheWeek = "string",
Time = "string",
},
Name = "string",
Labels =
{
{ "string", "string" },
},
PublicIps = new[]
{
"string",
},
CpuFamily = "string",
ServerType = "string",
AutoScaling = new Ionoscloud.K8s.Inputs.NodePoolAutoScalingArgs
{
MaxNodeCount = 0,
MinNodeCount = 0,
},
Annotations =
{
{ "string", "string" },
},
});
example, err := k8s.NewNodePool(ctx, "nodePoolResource", &k8s.NodePoolArgs{
NodeCount: pulumi.Int(0),
StorageType: pulumi.String("string"),
StorageSize: pulumi.Int(0),
AvailabilityZone: pulumi.String("string"),
CoresCount: pulumi.Int(0),
RamSize: pulumi.Int(0),
DatacenterId: pulumi.String("string"),
K8sClusterId: pulumi.String("string"),
K8sVersion: pulumi.String("string"),
Lans: k8s.NodePoolLanArray{
&k8s.NodePoolLanArgs{
Id: pulumi.Int(0),
Dhcp: pulumi.Bool(false),
Routes: k8s.NodePoolLanRouteArray{
&k8s.NodePoolLanRouteArgs{
GatewayIp: pulumi.String("string"),
Network: pulumi.String("string"),
},
},
},
},
AllowReplace: pulumi.Bool(false),
Location: pulumi.String("string"),
MaintenanceWindow: &k8s.NodePoolMaintenanceWindowArgs{
DayOfTheWeek: pulumi.String("string"),
Time: pulumi.String("string"),
},
Name: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
PublicIps: pulumi.StringArray{
pulumi.String("string"),
},
CpuFamily: pulumi.String("string"),
ServerType: pulumi.String("string"),
AutoScaling: &k8s.NodePoolAutoScalingArgs{
MaxNodeCount: pulumi.Int(0),
MinNodeCount: pulumi.Int(0),
},
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var nodePoolResource = new NodePool("nodePoolResource", NodePoolArgs.builder()
.nodeCount(0)
.storageType("string")
.storageSize(0)
.availabilityZone("string")
.coresCount(0)
.ramSize(0)
.datacenterId("string")
.k8sClusterId("string")
.k8sVersion("string")
.lans(NodePoolLanArgs.builder()
.id(0)
.dhcp(false)
.routes(NodePoolLanRouteArgs.builder()
.gatewayIp("string")
.network("string")
.build())
.build())
.allowReplace(false)
.location("string")
.maintenanceWindow(NodePoolMaintenanceWindowArgs.builder()
.dayOfTheWeek("string")
.time("string")
.build())
.name("string")
.labels(Map.of("string", "string"))
.publicIps("string")
.cpuFamily("string")
.serverType("string")
.autoScaling(NodePoolAutoScalingArgs.builder()
.maxNodeCount(0)
.minNodeCount(0)
.build())
.annotations(Map.of("string", "string"))
.build());
node_pool_resource = ionoscloud.k8s.NodePool("nodePoolResource",
node_count=0,
storage_type="string",
storage_size=0,
availability_zone="string",
cores_count=0,
ram_size=0,
datacenter_id="string",
k8s_cluster_id="string",
k8s_version="string",
lans=[{
"id": 0,
"dhcp": False,
"routes": [{
"gateway_ip": "string",
"network": "string",
}],
}],
allow_replace=False,
location="string",
maintenance_window={
"day_of_the_week": "string",
"time": "string",
},
name="string",
labels={
"string": "string",
},
public_ips=["string"],
cpu_family="string",
server_type="string",
auto_scaling={
"max_node_count": 0,
"min_node_count": 0,
},
annotations={
"string": "string",
})
const nodePoolResource = new ionoscloud.k8s.NodePool("nodePoolResource", {
nodeCount: 0,
storageType: "string",
storageSize: 0,
availabilityZone: "string",
coresCount: 0,
ramSize: 0,
datacenterId: "string",
k8sClusterId: "string",
k8sVersion: "string",
lans: [{
id: 0,
dhcp: false,
routes: [{
gatewayIp: "string",
network: "string",
}],
}],
allowReplace: false,
location: "string",
maintenanceWindow: {
dayOfTheWeek: "string",
time: "string",
},
name: "string",
labels: {
string: "string",
},
publicIps: ["string"],
cpuFamily: "string",
serverType: "string",
autoScaling: {
maxNodeCount: 0,
minNodeCount: 0,
},
annotations: {
string: "string",
},
});
type: ionoscloud:k8s:NodePool
properties:
allowReplace: false
annotations:
string: string
autoScaling:
maxNodeCount: 0
minNodeCount: 0
availabilityZone: string
coresCount: 0
cpuFamily: string
datacenterId: string
k8sClusterId: string
k8sVersion: string
labels:
string: string
lans:
- dhcp: false
id: 0
routes:
- gatewayIp: string
network: string
location: string
maintenanceWindow:
dayOfTheWeek: string
time: string
name: string
nodeCount: 0
publicIps:
- string
ramSize: 0
serverType: string
storageSize: 0
storageType: string
NodePool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The NodePool resource accepts the following input properties:
- Availability
Zone string - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- Cores
Count int - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- Datacenter
Id string - [string] A Datacenter's UUID
- K8s
Cluster stringId - [string] A k8s cluster's UUID
- K8s
Version string - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- Node
Count int - [int] - The desired number of nodes in the node pool
- Ram
Size int - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- Storage
Size int - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- Storage
Type string - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- Allow
Replace bool [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- Annotations Dictionary<string, string>
- [map] A key/value map of annotations
- Auto
Scaling Ionoscloud.Node Pool Auto Scaling - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- Cpu
Family string - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- Labels Dictionary<string, string>
- [map] A key/value map of labels
- Lans
List<Ionoscloud.
Node Pool Lan> - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- Location string
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- Maintenance
Window Ionoscloud.Node Pool Maintenance Window - See the maintenance_window section in the example above
- Name string
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- Public
Ips List<string> - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - Server
Type string - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU
- Availability
Zone string - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- Cores
Count int - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- Datacenter
Id string - [string] A Datacenter's UUID
- K8s
Cluster stringId - [string] A k8s cluster's UUID
- K8s
Version string - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- Node
Count int - [int] - The desired number of nodes in the node pool
- Ram
Size int - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- Storage
Size int - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- Storage
Type string - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- Allow
Replace bool [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- Annotations map[string]string
- [map] A key/value map of annotations
- Auto
Scaling NodePool Auto Scaling Args - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- Cpu
Family string - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- Labels map[string]string
- [map] A key/value map of labels
- Lans
[]Node
Pool Lan Args - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- Location string
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- Maintenance
Window NodePool Maintenance Window Args - See the maintenance_window section in the example above
- Name string
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- Public
Ips []string - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - Server
Type string - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU
- availability
Zone String - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- cores
Count Integer - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- datacenter
Id String - [string] A Datacenter's UUID
- k8s
Cluster StringId - [string] A k8s cluster's UUID
- k8s
Version String - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- node
Count Integer - [int] - The desired number of nodes in the node pool
- ram
Size Integer - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- storage
Size Integer - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- storage
Type String - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- allow
Replace Boolean [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- annotations Map<String,String>
- [map] A key/value map of annotations
- auto
Scaling NodePool Auto Scaling - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- cpu
Family String - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- labels Map<String,String>
- [map] A key/value map of labels
- lans
List<Node
Pool Lan> - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- location String
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- maintenance
Window NodePool Maintenance Window - See the maintenance_window section in the example above
- name String
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- public
Ips List<String> - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - server
Type String - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU
- availability
Zone string - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- cores
Count number - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- datacenter
Id string - [string] A Datacenter's UUID
- k8s
Cluster stringId - [string] A k8s cluster's UUID
- k8s
Version string - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- node
Count number - [int] - The desired number of nodes in the node pool
- ram
Size number - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- storage
Size number - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- storage
Type string - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- allow
Replace boolean [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- annotations {[key: string]: string}
- [map] A key/value map of annotations
- auto
Scaling NodePool Auto Scaling - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- cpu
Family string - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- labels {[key: string]: string}
- [map] A key/value map of labels
- lans
Node
Pool Lan[] - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- location string
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- maintenance
Window NodePool Maintenance Window - See the maintenance_window section in the example above
- name string
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- public
Ips string[] - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - server
Type string - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU
- availability_
zone str - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- cores_
count int - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- datacenter_
id str - [string] A Datacenter's UUID
- k8s_
cluster_ strid - [string] A k8s cluster's UUID
- k8s_
version str - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- node_
count int - [int] - The desired number of nodes in the node pool
- ram_
size int - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- storage_
size int - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- storage_
type str - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- allow_
replace bool [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- annotations Mapping[str, str]
- [map] A key/value map of annotations
- auto_
scaling NodePool Auto Scaling Args - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- cpu_
family str - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- labels Mapping[str, str]
- [map] A key/value map of labels
- lans
Sequence[Node
Pool Lan Args] - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- location str
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- maintenance_
window NodePool Maintenance Window Args - See the maintenance_window section in the example above
- name str
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- public_
ips Sequence[str] - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - server_
type str - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU
- availability
Zone String - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- cores
Count Number - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- datacenter
Id String - [string] A Datacenter's UUID
- k8s
Cluster StringId - [string] A k8s cluster's UUID
- k8s
Version String - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- node
Count Number - [int] - The desired number of nodes in the node pool
- ram
Size Number - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- storage
Size Number - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- storage
Type String - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- allow
Replace Boolean [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- annotations Map<String>
- [map] A key/value map of annotations
- auto
Scaling Property Map - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- cpu
Family String - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- labels Map<String>
- [map] A key/value map of labels
- lans List<Property Map>
- [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- location String
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- maintenance
Window Property Map - See the maintenance_window section in the example above
- name String
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- public
Ips List<String> - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - server
Type String - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU
Outputs
All input properties are implicitly available as output properties. Additionally, the NodePool resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing NodePool Resource
Get an existing NodePool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: NodePoolState, opts?: CustomResourceOptions): NodePool@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_replace: Optional[bool] = None,
annotations: Optional[Mapping[str, str]] = None,
auto_scaling: Optional[NodePoolAutoScalingArgs] = None,
availability_zone: Optional[str] = None,
cores_count: Optional[int] = None,
cpu_family: Optional[str] = None,
datacenter_id: Optional[str] = None,
k8s_cluster_id: Optional[str] = None,
k8s_version: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
lans: Optional[Sequence[NodePoolLanArgs]] = None,
location: Optional[str] = None,
maintenance_window: Optional[NodePoolMaintenanceWindowArgs] = None,
name: Optional[str] = None,
node_count: Optional[int] = None,
public_ips: Optional[Sequence[str]] = None,
ram_size: Optional[int] = None,
server_type: Optional[str] = None,
storage_size: Optional[int] = None,
storage_type: Optional[str] = None) -> NodePoolfunc GetNodePool(ctx *Context, name string, id IDInput, state *NodePoolState, opts ...ResourceOption) (*NodePool, error)public static NodePool Get(string name, Input<string> id, NodePoolState? state, CustomResourceOptions? opts = null)public static NodePool get(String name, Output<String> id, NodePoolState state, CustomResourceOptions options)resources: _: type: ionoscloud:k8s:NodePool get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Allow
Replace bool [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- Annotations Dictionary<string, string>
- [map] A key/value map of annotations
- Auto
Scaling Ionoscloud.Node Pool Auto Scaling - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- Availability
Zone string - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- Cores
Count int - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- Cpu
Family string - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- Datacenter
Id string - [string] A Datacenter's UUID
- K8s
Cluster stringId - [string] A k8s cluster's UUID
- K8s
Version string - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- Labels Dictionary<string, string>
- [map] A key/value map of labels
- Lans
List<Ionoscloud.
Node Pool Lan> - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- Location string
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- Maintenance
Window Ionoscloud.Node Pool Maintenance Window - See the maintenance_window section in the example above
- Name string
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- Node
Count int - [int] - The desired number of nodes in the node pool
- Public
Ips List<string> - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - Ram
Size int - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- Server
Type string - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU - Storage
Size int - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- Storage
Type string - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- Allow
Replace bool [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- Annotations map[string]string
- [map] A key/value map of annotations
- Auto
Scaling NodePool Auto Scaling Args - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- Availability
Zone string - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- Cores
Count int - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- Cpu
Family string - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- Datacenter
Id string - [string] A Datacenter's UUID
- K8s
Cluster stringId - [string] A k8s cluster's UUID
- K8s
Version string - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- Labels map[string]string
- [map] A key/value map of labels
- Lans
[]Node
Pool Lan Args - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- Location string
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- Maintenance
Window NodePool Maintenance Window Args - See the maintenance_window section in the example above
- Name string
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- Node
Count int - [int] - The desired number of nodes in the node pool
- Public
Ips []string - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - Ram
Size int - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- Server
Type string - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU - Storage
Size int - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- Storage
Type string - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- allow
Replace Boolean [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- annotations Map<String,String>
- [map] A key/value map of annotations
- auto
Scaling NodePool Auto Scaling - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- availability
Zone String - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- cores
Count Integer - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- cpu
Family String - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- datacenter
Id String - [string] A Datacenter's UUID
- k8s
Cluster StringId - [string] A k8s cluster's UUID
- k8s
Version String - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- labels Map<String,String>
- [map] A key/value map of labels
- lans
List<Node
Pool Lan> - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- location String
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- maintenance
Window NodePool Maintenance Window - See the maintenance_window section in the example above
- name String
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- node
Count Integer - [int] - The desired number of nodes in the node pool
- public
Ips List<String> - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - ram
Size Integer - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- server
Type String - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU - storage
Size Integer - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- storage
Type String - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- allow
Replace boolean [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- annotations {[key: string]: string}
- [map] A key/value map of annotations
- auto
Scaling NodePool Auto Scaling - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- availability
Zone string - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- cores
Count number - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- cpu
Family string - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- datacenter
Id string - [string] A Datacenter's UUID
- k8s
Cluster stringId - [string] A k8s cluster's UUID
- k8s
Version string - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- labels {[key: string]: string}
- [map] A key/value map of labels
- lans
Node
Pool Lan[] - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- location string
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- maintenance
Window NodePool Maintenance Window - See the maintenance_window section in the example above
- name string
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- node
Count number - [int] - The desired number of nodes in the node pool
- public
Ips string[] - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - ram
Size number - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- server
Type string - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU - storage
Size number - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- storage
Type string - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- allow_
replace bool [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- annotations Mapping[str, str]
- [map] A key/value map of annotations
- auto_
scaling NodePool Auto Scaling Args - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- availability_
zone str - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- cores_
count int - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- cpu_
family str - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- datacenter_
id str - [string] A Datacenter's UUID
- k8s_
cluster_ strid - [string] A k8s cluster's UUID
- k8s_
version str - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- labels Mapping[str, str]
- [map] A key/value map of labels
- lans
Sequence[Node
Pool Lan Args] - [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- location str
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- maintenance_
window NodePool Maintenance Window Args - See the maintenance_window section in the example above
- name str
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- node_
count int - [int] - The desired number of nodes in the node pool
- public_
ips Sequence[str] - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - ram_
size int - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- server_
type str - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU - storage_
size int - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- storage_
type str - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
- allow
Replace Boolean [bool] When set to true, allows the update of immutable fields by first destroying and then re-creating the node pool.
⚠️ Warning:
allowReplace- lets you update immutable fields, but it first destroys and then re-creates the node pool in order to do it. Set the field to true only if you know what you are doing. This will cause a downtime for all pods on that nodepool. Consider adding multiple nodepools and update one after the other for downtime free nodepool upgrade.Immutable fields list: name, cpu_family, availability_zone, cores_count, ram_size, storage_size, storage_type.
⚠️ Note:
Be careful when using
autoScalingsince the number of nodes can change. Because of that, when runningpulumi preview, Terraform will think that an update is required (sincenodeCountfrom thetfplan will be different from the number of nodes set by the scheduler). To avoid that, you can use:- annotations Map<String>
- [map] A key/value map of annotations
- auto
Scaling Property Map - [string] Whether the Node Pool should autoscale. For more details, please check the API documentation
- availability
Zone String - [string] - The desired Compute availability zone - See the API documentation for more information. This attribute is immutable.
- cores
Count Number - [int] - The CPU cores count for each node of the node pool. This attribute is immutable.
- cpu
Family String - [string] The desired CPU Family - See the API documentation for more information. This attribute is immutable.
- datacenter
Id String - [string] A Datacenter's UUID
- k8s
Cluster StringId - [string] A k8s cluster's UUID
- k8s
Version String - [string] The desired Kubernetes Version. For supported values, please check the API documentation. Downgrades are not supported. The provider will ignore downgrades of patch level.
- labels Map<String>
- [map] A key/value map of labels
- lans List<Property Map>
- [list] A list of numeric LAN id's you want this node pool to be part of. For more details, please check the API documentation, as well as the example above
- location String
- The location of the resource. This field should be used only if you are also using a file configuration and should not be configured otherwise.
- maintenance
Window Property Map - See the maintenance_window section in the example above
- name String
- [string] The name of the Kubernetes Cluster. This attribute is immutable.
- node
Count Number - [int] - The desired number of nodes in the node pool
- public
Ips List<String> - [list] A list of public IPs associated with the node pool; must have at least
nodeCount + 1elements - ram
Size Number - [int] - The desired amount of RAM, in MB. This attribute is immutable.
- server
Type String - [string] The server type for the compute engine - See the API documentation for more information. Possible values:
DedicatedCore,VCPU - storage
Size Number - [int] - The size of the volume in GB. The size should be greater than 10GB. This attribute is immutable.
- storage
Type String - [string] - The desired storage type - SSD/HDD. This attribute is immutable.
Supporting Types
NodePoolAutoScaling, NodePoolAutoScalingArgs
- Max
Node intCount - [int] The maximum number of worker nodes that the node pool can scale to. Should be greater than min_node_count
- Min
Node intCount - [int] The minimum number of worker nodes the node pool can scale down to. Should be less than max_node_count
- Max
Node intCount - [int] The maximum number of worker nodes that the node pool can scale to. Should be greater than min_node_count
- Min
Node intCount - [int] The minimum number of worker nodes the node pool can scale down to. Should be less than max_node_count
- max
Node IntegerCount - [int] The maximum number of worker nodes that the node pool can scale to. Should be greater than min_node_count
- min
Node IntegerCount - [int] The minimum number of worker nodes the node pool can scale down to. Should be less than max_node_count
- max
Node numberCount - [int] The maximum number of worker nodes that the node pool can scale to. Should be greater than min_node_count
- min
Node numberCount - [int] The minimum number of worker nodes the node pool can scale down to. Should be less than max_node_count
- max_
node_ intcount - [int] The maximum number of worker nodes that the node pool can scale to. Should be greater than min_node_count
- min_
node_ intcount - [int] The minimum number of worker nodes the node pool can scale down to. Should be less than max_node_count
- max
Node NumberCount - [int] The maximum number of worker nodes that the node pool can scale to. Should be greater than min_node_count
- min
Node NumberCount - [int] The minimum number of worker nodes the node pool can scale down to. Should be less than max_node_count
NodePoolLan, NodePoolLanArgs
- Id int
- [int] The LAN ID of an existing LAN at the related datacenter
- Dhcp bool
- [boolean] Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP. Default value is
true - Routes
List<Ionoscloud.
Node Pool Lan Route> - An array of additional LANs attached to worker nodes
- Id int
- [int] The LAN ID of an existing LAN at the related datacenter
- Dhcp bool
- [boolean] Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP. Default value is
true - Routes
[]Node
Pool Lan Route - An array of additional LANs attached to worker nodes
- id Integer
- [int] The LAN ID of an existing LAN at the related datacenter
- dhcp Boolean
- [boolean] Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP. Default value is
true - routes
List<Node
Pool Lan Route> - An array of additional LANs attached to worker nodes
- id number
- [int] The LAN ID of an existing LAN at the related datacenter
- dhcp boolean
- [boolean] Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP. Default value is
true - routes
Node
Pool Lan Route[] - An array of additional LANs attached to worker nodes
- id int
- [int] The LAN ID of an existing LAN at the related datacenter
- dhcp bool
- [boolean] Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP. Default value is
true - routes
Sequence[Node
Pool Lan Route] - An array of additional LANs attached to worker nodes
- id Number
- [int] The LAN ID of an existing LAN at the related datacenter
- dhcp Boolean
- [boolean] Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP. Default value is
true - routes List<Property Map>
- An array of additional LANs attached to worker nodes
NodePoolLanRoute, NodePoolLanRouteArgs
- gateway_
ip str - [string] IPv4 or IPv6 Gateway IP for the route
- network str
- [string] IPv4 or IPv6 CIDR to be routed via the interface
NodePoolMaintenanceWindow, NodePoolMaintenanceWindowArgs
- Day
Of stringThe Week - [string] Day of the week when maintenance is allowed
- Time string
- [string] A clock time in the day when maintenance is allowed
- Day
Of stringThe Week - [string] Day of the week when maintenance is allowed
- Time string
- [string] A clock time in the day when maintenance is allowed
- day
Of StringThe Week - [string] Day of the week when maintenance is allowed
- time String
- [string] A clock time in the day when maintenance is allowed
- day
Of stringThe Week - [string] Day of the week when maintenance is allowed
- time string
- [string] A clock time in the day when maintenance is allowed
- day_
of_ strthe_ week - [string] Day of the week when maintenance is allowed
- time str
- [string] A clock time in the day when maintenance is allowed
- day
Of StringThe Week - [string] Day of the week when maintenance is allowed
- time String
- [string] A clock time in the day when maintenance is allowed
Import
A Kubernetes Node Pool resource can be imported using its Kubernetes cluster’s uuid as well as its own UUID, both of which you can retrieve from the cloud API: resource id, e.g.:
$ pulumi import ionoscloud:k8s/nodePool:NodePool demo k8s_cluster_uuid/k8s_nodepool_id
This can be helpful when you want to import kubernetes node pools which you have already created manually or using other means, outside of terraform, towards the goal of managing them via Terraform
⚠️ Warning: **During a maintenance window, k8s can update your k8sVersion if the old one reaches end of life. This upgrade will not be shown in the plan, as we prevent
terraform from doing a downgrade, as downgrading k8sVersion is not supported.
⚠️ Warning: If you are upgrading from v5.x.x to v6.x.x: You have to modify you plan for lans to match the new structure, by putting the ids from the old slice in lans.id fields. This is not backwards compatible.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ionoscloud ionos-cloud/pulumi-ionoscloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ionoscloudTerraform Provider.
published on Wednesday, Apr 15, 2026 by ionos-cloud
