Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ionoscloud
  3. API Docs
  4. dsaas
  5. getNodePools
IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud
ionos-cloud/pulumi-ionoscloud

ionoscloud.dsaas.getNodePools

Explore with Pulumi AI

ionoscloud logo
IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud
ionos-cloud/pulumi-ionoscloud

    The Dataplatform Node Pools Data Source can be used to search for and return a list of existing Dataplatform Node Pools under a Dataplatform Cluster.

    Example Usage

    All Node Pools under a Cluster ID

    import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";

const example = ionoscloud.dsaas.getNodePools({
    clusterId: "cluster_id",
});

    import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.dsaas.get_node_pools(cluster_id="cluster_id")

    package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/dsaas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dsaas.GetNodePools(ctx, &dsaas.GetNodePoolsArgs{
			ClusterId: "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.Dsaas.GetNodePools.Invoke(new()
    {
        ClusterId = "cluster_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.dsaas.DsaasFunctions;
import com.pulumi.ionoscloud.dsaas.inputs.GetNodePoolsArgs;
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 = DsaasFunctions.getNodePools(GetNodePoolsArgs.builder()
            .clusterId("cluster_id")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ionoscloud:dsaas:getNodePools
      arguments:
        clusterId: cluster_id

    By Name

    import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";

const example = ionoscloud.dsaas.getNodePools({
    clusterId: "cluster_id",
    name: "Dataplatform_Node_Pool_Example",
});

    import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.dsaas.get_node_pools(cluster_id="cluster_id",
    name="Dataplatform_Node_Pool_Example")

    package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/dsaas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dsaas.GetNodePools(ctx, &dsaas.GetNodePoolsArgs{
			ClusterId: "cluster_id",
			Name:      pulumi.StringRef("Dataplatform_Node_Pool_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.Dsaas.GetNodePools.Invoke(new()
    {
        ClusterId = "cluster_id",
        Name = "Dataplatform_Node_Pool_Example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.dsaas.DsaasFunctions;
import com.pulumi.ionoscloud.dsaas.inputs.GetNodePoolsArgs;
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 = DsaasFunctions.getNodePools(GetNodePoolsArgs.builder()
            .clusterId("cluster_id")
            .name("Dataplatform_Node_Pool_Example")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ionoscloud:dsaas:getNodePools
      arguments:
        clusterId: cluster_id
        name: Dataplatform_Node_Pool_Example

    By Name with Partial Match

    import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";

const example = ionoscloud.dsaas.getNodePools({
    clusterId: "cluster_id",
    name: "_Example",
    partialMatch: true,
});

    import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.dsaas.get_node_pools(cluster_id="cluster_id",
    name="_Example",
    partial_match=True)

    package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/dsaas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dsaas.GetNodePools(ctx, &dsaas.GetNodePoolsArgs{
			ClusterId:    "cluster_id",
			Name:         pulumi.StringRef("_Example"),
			PartialMatch: pulumi.BoolRef(true),
		}, 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.Dsaas.GetNodePools.Invoke(new()
    {
        ClusterId = "cluster_id",
        Name = "_Example",
        PartialMatch = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.dsaas.DsaasFunctions;
import com.pulumi.ionoscloud.dsaas.inputs.GetNodePoolsArgs;
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 = DsaasFunctions.getNodePools(GetNodePoolsArgs.builder()
            .clusterId("cluster_id")
            .name("_Example")
            .partialMatch(true)
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ionoscloud:dsaas:getNodePools
      arguments:
        clusterId: cluster_id
        name: _Example
        partialMatch: true

    Using getNodePools

    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 getNodePools(args: GetNodePoolsArgs, opts?: InvokeOptions): Promise<GetNodePoolsResult>
function getNodePoolsOutput(args: GetNodePoolsOutputArgs, opts?: InvokeOptions): Output<GetNodePoolsResult>
    def get_node_pools(cluster_id: Optional[str] = None,
                   name: Optional[str] = None,
                   partial_match: Optional[bool] = None,
                   opts: Optional[InvokeOptions] = None) -> GetNodePoolsResult
def get_node_pools_output(cluster_id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   partial_match: Optional[pulumi.Input[bool]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetNodePoolsResult]
    func GetNodePools(ctx *Context, args *GetNodePoolsArgs, opts ...InvokeOption) (*GetNodePoolsResult, error)
func GetNodePoolsOutput(ctx *Context, args *GetNodePoolsOutputArgs, opts ...InvokeOption) GetNodePoolsResultOutput

    > Note: This function is named GetNodePools in the Go SDK.

    public static class GetNodePools 
{
    public static Task<GetNodePoolsResult> InvokeAsync(GetNodePoolsArgs args, InvokeOptions? opts = null)
    public static Output<GetNodePoolsResult> Invoke(GetNodePoolsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNodePoolsResult> getNodePools(GetNodePoolsArgs args, InvokeOptions options)
public static Output<GetNodePoolsResult> getNodePools(GetNodePoolsArgs args, InvokeOptions options)

    fn::invoke:
  function: ionoscloud:dsaas/getNodePools:getNodePools
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    ID of the cluster the searched node pool is part of.
    Name string
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    PartialMatch bool
    Whether partial matching is allowed or not when using name argument. Default value is false.
    ClusterId string
    ID of the cluster the searched node pool is part of.
    Name string
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    PartialMatch bool
    Whether partial matching is allowed or not when using name argument. Default value is false.
    clusterId String
    ID of the cluster the searched node pool is part of.
    name String
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    partialMatch Boolean
    Whether partial matching is allowed or not when using name argument. Default value is false.
    clusterId string
    ID of the cluster the searched node pool is part of.
    name string
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    partialMatch boolean
    Whether partial matching is allowed or not when using name argument. Default value is false.
    cluster_id str
    ID of the cluster the searched node pool is part of.
    name str
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    partial_match bool
    Whether partial matching is allowed or not when using name argument. Default value is false.
    clusterId String
    ID of the cluster the searched node pool is part of.
    name String
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    partialMatch Boolean
    Whether partial matching is allowed or not when using name argument. Default value is false.

    getNodePools Result

    The following output properties are available:

    ClusterId string
    ID of the cluster the searched node pool is part of.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodePools List<Ionoscloud.GetNodePoolsNodePool>
    List of Node Pools - See the Node Pool section.
    Name string
    PartialMatch bool
    ClusterId string
    ID of the cluster the searched node pool is part of.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodePools []GetNodePoolsNodePool
    List of Node Pools - See the Node Pool section.
    Name string
    PartialMatch bool
    clusterId String
    ID of the cluster the searched node pool is part of.
    id String
    The provider-assigned unique ID for this managed resource.
    nodePools List<GetNodePoolsNodePool>
    List of Node Pools - See the Node Pool section.
    name String
    partialMatch Boolean
    clusterId string
    ID of the cluster the searched node pool is part of.
    id string
    The provider-assigned unique ID for this managed resource.
    nodePools GetNodePoolsNodePool[]
    List of Node Pools - See the Node Pool section.
    name string
    partialMatch boolean
    cluster_id str
    ID of the cluster the searched node pool is part of.
    id str
    The provider-assigned unique ID for this managed resource.
    node_pools Sequence[GetNodePoolsNodePool]
    List of Node Pools - See the Node Pool section.
    name str
    partial_match bool
    clusterId String
    ID of the cluster the searched node pool is part of.
    id String
    The provider-assigned unique ID for this managed resource.
    nodePools List<Property Map>
    List of Node Pools - See the Node Pool section.
    name String
    partialMatch Boolean

    Supporting Types

    GetNodePoolsNodePool

    Annotations Dictionary<string, string>
    Key-value pairs attached to node pool resource as kubernetes annotations
    AvailabilityZone string
    The availability zone of the virtual datacenter region where the node pool resources should be provisioned.
    CoresCount int
    The number of CPU cores per node.
    CpuFamily string
    A valid CPU family name or AUTO if the platform shall choose the best fitting option. Available CPU architectures can be retrieved from the datacenter resource.
    DatacenterId string
    The UUID of the virtual data center (VDC) in which the node pool is provisioned
    Id string
    Labels Dictionary<string, string>
    Key-value pairs attached to the node pool resource as kubernetes labels
    MaintenanceWindows List<Ionoscloud.GetNodePoolsNodePoolMaintenanceWindow>
    Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
    Name string
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    NodeCount int
    The number of nodes that make up the node pool.
    RamSize int
    The RAM size for one node in MB. Must be set in multiples of 1024 MB, with a minimum size is of 2048 MB.
    StorageSize int
    The size of the volume in GB. The size must be greater than 10GB.
    StorageType string
    The type of hardware for the volume.
    Version string
    The version of the Data Platform.
    Annotations map[string]string
    Key-value pairs attached to node pool resource as kubernetes annotations
    AvailabilityZone string
    The availability zone of the virtual datacenter region where the node pool resources should be provisioned.
    CoresCount int
    The number of CPU cores per node.
    CpuFamily string
    A valid CPU family name or AUTO if the platform shall choose the best fitting option. Available CPU architectures can be retrieved from the datacenter resource.
    DatacenterId string
    The UUID of the virtual data center (VDC) in which the node pool is provisioned
    Id string
    Labels map[string]string
    Key-value pairs attached to the node pool resource as kubernetes labels
    MaintenanceWindows []GetNodePoolsNodePoolMaintenanceWindow
    Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
    Name string
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    NodeCount int
    The number of nodes that make up the node pool.
    RamSize int
    The RAM size for one node in MB. Must be set in multiples of 1024 MB, with a minimum size is of 2048 MB.
    StorageSize int
    The size of the volume in GB. The size must be greater than 10GB.
    StorageType string
    The type of hardware for the volume.
    Version string
    The version of the Data Platform.
    annotations Map<String,String>
    Key-value pairs attached to node pool resource as kubernetes annotations
    availabilityZone String
    The availability zone of the virtual datacenter region where the node pool resources should be provisioned.
    coresCount Integer
    The number of CPU cores per node.
    cpuFamily String
    A valid CPU family name or AUTO if the platform shall choose the best fitting option. Available CPU architectures can be retrieved from the datacenter resource.
    datacenterId String
    The UUID of the virtual data center (VDC) in which the node pool is provisioned
    id String
    labels Map<String,String>
    Key-value pairs attached to the node pool resource as kubernetes labels
    maintenanceWindows List<GetNodePoolsNodePoolMaintenanceWindow>
    Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
    name String
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    nodeCount Integer
    The number of nodes that make up the node pool.
    ramSize Integer
    The RAM size for one node in MB. Must be set in multiples of 1024 MB, with a minimum size is of 2048 MB.
    storageSize Integer
    The size of the volume in GB. The size must be greater than 10GB.
    storageType String
    The type of hardware for the volume.
    version String
    The version of the Data Platform.
    annotations {[key: string]: string}
    Key-value pairs attached to node pool resource as kubernetes annotations
    availabilityZone string
    The availability zone of the virtual datacenter region where the node pool resources should be provisioned.
    coresCount number
    The number of CPU cores per node.
    cpuFamily string
    A valid CPU family name or AUTO if the platform shall choose the best fitting option. Available CPU architectures can be retrieved from the datacenter resource.
    datacenterId string
    The UUID of the virtual data center (VDC) in which the node pool is provisioned
    id string
    labels {[key: string]: string}
    Key-value pairs attached to the node pool resource as kubernetes labels
    maintenanceWindows GetNodePoolsNodePoolMaintenanceWindow[]
    Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
    name string
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    nodeCount number
    The number of nodes that make up the node pool.
    ramSize number
    The RAM size for one node in MB. Must be set in multiples of 1024 MB, with a minimum size is of 2048 MB.
    storageSize number
    The size of the volume in GB. The size must be greater than 10GB.
    storageType string
    The type of hardware for the volume.
    version string
    The version of the Data Platform.
    annotations Mapping[str, str]
    Key-value pairs attached to node pool resource as kubernetes annotations
    availability_zone str
    The availability zone of the virtual datacenter region where the node pool resources should be provisioned.
    cores_count int
    The number of CPU cores per node.
    cpu_family str
    A valid CPU family name or AUTO if the platform shall choose the best fitting option. Available CPU architectures can be retrieved from the datacenter resource.
    datacenter_id str
    The UUID of the virtual data center (VDC) in which the node pool is provisioned
    id str
    labels Mapping[str, str]
    Key-value pairs attached to the node pool resource as kubernetes labels
    maintenance_windows Sequence[GetNodePoolsNodePoolMaintenanceWindow]
    Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
    name str
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    node_count int
    The number of nodes that make up the node pool.
    ram_size int
    The RAM size for one node in MB. Must be set in multiples of 1024 MB, with a minimum size is of 2048 MB.
    storage_size int
    The size of the volume in GB. The size must be greater than 10GB.
    storage_type str
    The type of hardware for the volume.
    version str
    The version of the Data Platform.
    annotations Map<String>
    Key-value pairs attached to node pool resource as kubernetes annotations
    availabilityZone String
    The availability zone of the virtual datacenter region where the node pool resources should be provisioned.
    coresCount Number
    The number of CPU cores per node.
    cpuFamily String
    A valid CPU family name or AUTO if the platform shall choose the best fitting option. Available CPU architectures can be retrieved from the datacenter resource.
    datacenterId String
    The UUID of the virtual data center (VDC) in which the node pool is provisioned
    id String
    labels Map<String>
    Key-value pairs attached to the node pool resource as kubernetes labels
    maintenanceWindows List<Property Map>
    Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
    name String
    Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.
    nodeCount Number
    The number of nodes that make up the node pool.
    ramSize Number
    The RAM size for one node in MB. Must be set in multiples of 1024 MB, with a minimum size is of 2048 MB.
    storageSize Number
    The size of the volume in GB. The size must be greater than 10GB.
    storageType String
    The type of hardware for the volume.
    version String
    The version of the Data Platform.

    GetNodePoolsNodePoolMaintenanceWindow

    DayOfTheWeek string
    Time string
    Time at which the maintenance should start. Must conform to the 'HH:MM:SS' 24-hour format.
    DayOfTheWeek string
    Time string
    Time at which the maintenance should start. Must conform to the 'HH:MM:SS' 24-hour format.
    dayOfTheWeek String
    time String
    Time at which the maintenance should start. Must conform to the 'HH:MM:SS' 24-hour format.
    dayOfTheWeek string
    time string
    Time at which the maintenance should start. Must conform to the 'HH:MM:SS' 24-hour format.
    day_of_the_week str
    time str
    Time at which the maintenance should start. Must conform to the 'HH:MM:SS' 24-hour format.
    dayOfTheWeek String
    time String
    Time at which the maintenance should start. Must conform to the 'HH:MM:SS' 24-hour format.

    Package Details

    Repository
    ionoscloud ionos-cloud/pulumi-ionoscloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ionoscloud Terraform Provider.
    ionoscloud logo
    IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud
    ionos-cloud/pulumi-ionoscloud