1. Packages
  2. Ionoscloud Provider
  3. API Docs
  4. getDataplatformNodePools
ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionoscloud.getDataplatformNodePools

Explore with Pulumi AI

ionoscloud logo
ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

    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.getDataplatformNodePools({
        clusterId: "cluster_id",
    });
    
    import pulumi
    import pulumi_ionoscloud as ionoscloud
    
    example = ionoscloud.get_dataplatform_node_pools(cluster_id="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.GetDataplatformNodePools(ctx, &ionoscloud.GetDataplatformNodePoolsArgs{
    			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.GetDataplatformNodePools.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.IonoscloudFunctions;
    import com.pulumi.ionoscloud.inputs.GetDataplatformNodePoolsArgs;
    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.getDataplatformNodePools(GetDataplatformNodePoolsArgs.builder()
                .clusterId("cluster_id")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ionoscloud:getDataplatformNodePools
          arguments:
            clusterId: cluster_id
    

    By Name

    import * as pulumi from "@pulumi/pulumi";
    import * as ionoscloud from "@pulumi/ionoscloud";
    
    const example = ionoscloud.getDataplatformNodePools({
        clusterId: "cluster_id",
        name: "Dataplatform_Node_Pool_Example",
    });
    
    import pulumi
    import pulumi_ionoscloud as ionoscloud
    
    example = ionoscloud.get_dataplatform_node_pools(cluster_id="cluster_id",
        name="Dataplatform_Node_Pool_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.GetDataplatformNodePools(ctx, &ionoscloud.GetDataplatformNodePoolsArgs{
    			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.GetDataplatformNodePools.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.IonoscloudFunctions;
    import com.pulumi.ionoscloud.inputs.GetDataplatformNodePoolsArgs;
    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.getDataplatformNodePools(GetDataplatformNodePoolsArgs.builder()
                .clusterId("cluster_id")
                .name("Dataplatform_Node_Pool_Example")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ionoscloud:getDataplatformNodePools
          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.getDataplatformNodePools({
        clusterId: "cluster_id",
        name: "_Example",
        partialMatch: true,
    });
    
    import pulumi
    import pulumi_ionoscloud as ionoscloud
    
    example = ionoscloud.get_dataplatform_node_pools(cluster_id="cluster_id",
        name="_Example",
        partial_match=True)
    
    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.GetDataplatformNodePools(ctx, &ionoscloud.GetDataplatformNodePoolsArgs{
    			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.GetDataplatformNodePools.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.IonoscloudFunctions;
    import com.pulumi.ionoscloud.inputs.GetDataplatformNodePoolsArgs;
    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.getDataplatformNodePools(GetDataplatformNodePoolsArgs.builder()
                .clusterId("cluster_id")
                .name("_Example")
                .partialMatch(true)
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ionoscloud:getDataplatformNodePools
          arguments:
            clusterId: cluster_id
            name: _Example
            partialMatch: true
    

    Using getDataplatformNodePools

    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 getDataplatformNodePools(args: GetDataplatformNodePoolsArgs, opts?: InvokeOptions): Promise<GetDataplatformNodePoolsResult>
    function getDataplatformNodePoolsOutput(args: GetDataplatformNodePoolsOutputArgs, opts?: InvokeOptions): Output<GetDataplatformNodePoolsResult>
    def get_dataplatform_node_pools(cluster_id: Optional[str] = None,
                                    id: Optional[str] = None,
                                    name: Optional[str] = None,
                                    partial_match: Optional[bool] = None,
                                    timeouts: Optional[GetDataplatformNodePoolsTimeouts] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetDataplatformNodePoolsResult
    def get_dataplatform_node_pools_output(cluster_id: Optional[pulumi.Input[str]] = None,
                                    id: Optional[pulumi.Input[str]] = None,
                                    name: Optional[pulumi.Input[str]] = None,
                                    partial_match: Optional[pulumi.Input[bool]] = None,
                                    timeouts: Optional[pulumi.Input[GetDataplatformNodePoolsTimeoutsArgs]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetDataplatformNodePoolsResult]
    func GetDataplatformNodePools(ctx *Context, args *GetDataplatformNodePoolsArgs, opts ...InvokeOption) (*GetDataplatformNodePoolsResult, error)
    func GetDataplatformNodePoolsOutput(ctx *Context, args *GetDataplatformNodePoolsOutputArgs, opts ...InvokeOption) GetDataplatformNodePoolsResultOutput

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

    public static class GetDataplatformNodePools 
    {
        public static Task<GetDataplatformNodePoolsResult> InvokeAsync(GetDataplatformNodePoolsArgs args, InvokeOptions? opts = null)
        public static Output<GetDataplatformNodePoolsResult> Invoke(GetDataplatformNodePoolsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDataplatformNodePoolsResult> getDataplatformNodePools(GetDataplatformNodePoolsArgs args, InvokeOptions options)
    public static Output<GetDataplatformNodePoolsResult> getDataplatformNodePools(GetDataplatformNodePoolsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ionoscloud:index/getDataplatformNodePools:getDataplatformNodePools
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterId string
    ID of the cluster the searched node pool is part of.
    Id string
    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.
    Timeouts GetDataplatformNodePoolsTimeouts
    ClusterId string
    ID of the cluster the searched node pool is part of.
    Id string
    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.
    Timeouts GetDataplatformNodePoolsTimeouts
    clusterId String
    ID of the cluster the searched node pool is part of.
    id String
    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.
    timeouts GetDataplatformNodePoolsTimeouts
    clusterId string
    ID of the cluster the searched node pool is part of.
    id string
    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.
    timeouts GetDataplatformNodePoolsTimeouts
    cluster_id str
    ID of the cluster the searched node pool is part of.
    id str
    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.
    timeouts GetDataplatformNodePoolsTimeouts
    clusterId String
    ID of the cluster the searched node pool is part of.
    id String
    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.
    timeouts Property Map

    getDataplatformNodePools Result

    The following output properties are available:

    ClusterId string
    ID of the cluster the searched node pool is part of.
    Id string
    NodePools List<GetDataplatformNodePoolsNodePool>
    List of Node Pools - See the Node Pool section.
    Name string
    PartialMatch bool
    Timeouts GetDataplatformNodePoolsTimeouts
    ClusterId string
    ID of the cluster the searched node pool is part of.
    Id string
    NodePools []GetDataplatformNodePoolsNodePool
    List of Node Pools - See the Node Pool section.
    Name string
    PartialMatch bool
    Timeouts GetDataplatformNodePoolsTimeouts
    clusterId String
    ID of the cluster the searched node pool is part of.
    id String
    nodePools List<GetDataplatformNodePoolsNodePool>
    List of Node Pools - See the Node Pool section.
    name String
    partialMatch Boolean
    timeouts GetDataplatformNodePoolsTimeouts
    clusterId string
    ID of the cluster the searched node pool is part of.
    id string
    nodePools GetDataplatformNodePoolsNodePool[]
    List of Node Pools - See the Node Pool section.
    name string
    partialMatch boolean
    timeouts GetDataplatformNodePoolsTimeouts
    cluster_id str
    ID of the cluster the searched node pool is part of.
    id str
    node_pools Sequence[GetDataplatformNodePoolsNodePool]
    List of Node Pools - See the Node Pool section.
    name str
    partial_match bool
    timeouts GetDataplatformNodePoolsTimeouts
    clusterId String
    ID of the cluster the searched node pool is part of.
    id String
    nodePools List<Property Map>
    List of Node Pools - See the Node Pool section.
    name String
    partialMatch Boolean
    timeouts Property Map

    Supporting Types

    GetDataplatformNodePoolsNodePool

    Annotations Dictionary<string, string>
    AvailabilityZone string
    CoresCount double
    CpuFamily string
    DatacenterId string
    Id string
    Labels Dictionary<string, string>
    MaintenanceWindows List<GetDataplatformNodePoolsNodePoolMaintenanceWindow>
    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 double
    RamSize double
    StorageSize double
    StorageType string
    Version string
    Annotations map[string]string
    AvailabilityZone string
    CoresCount float64
    CpuFamily string
    DatacenterId string
    Id string
    Labels map[string]string
    MaintenanceWindows []GetDataplatformNodePoolsNodePoolMaintenanceWindow
    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 float64
    RamSize float64
    StorageSize float64
    StorageType string
    Version string
    annotations Map<String,String>
    availabilityZone String
    coresCount Double
    cpuFamily String
    datacenterId String
    id String
    labels Map<String,String>
    maintenanceWindows List<GetDataplatformNodePoolsNodePoolMaintenanceWindow>
    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 Double
    ramSize Double
    storageSize Double
    storageType String
    version String
    annotations {[key: string]: string}
    availabilityZone string
    coresCount number
    cpuFamily string
    datacenterId string
    id string
    labels {[key: string]: string}
    maintenanceWindows GetDataplatformNodePoolsNodePoolMaintenanceWindow[]
    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
    ramSize number
    storageSize number
    storageType string
    version string
    annotations Mapping[str, str]
    availability_zone str
    cores_count float
    cpu_family str
    datacenter_id str
    id str
    labels Mapping[str, str]
    maintenance_windows Sequence[GetDataplatformNodePoolsNodePoolMaintenanceWindow]
    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 float
    ram_size float
    storage_size float
    storage_type str
    version str
    annotations Map<String>
    availabilityZone String
    coresCount Number
    cpuFamily String
    datacenterId String
    id String
    labels Map<String>
    maintenanceWindows List<Property Map>
    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
    ramSize Number
    storageSize Number
    storageType String
    version String

    GetDataplatformNodePoolsNodePoolMaintenanceWindow

    DayOfTheWeek string
    Time string
    DayOfTheWeek string
    Time string
    dayOfTheWeek String
    time String
    dayOfTheWeek string
    time string
    dayOfTheWeek String
    time String

    GetDataplatformNodePoolsTimeouts

    Create string
    Default string
    Delete string
    Update string
    Create string
    Default string
    Delete string
    Update string
    create String
    default_ String
    delete String
    update String
    create string
    default string
    delete string
    update string
    create String
    default String
    delete String
    update String

    Package Details

    Repository
    ionoscloud ionos-cloud/terraform-provider-ionoscloud
    License
    Notes
    This Pulumi package is based on the ionoscloud Terraform Provider.
    ionoscloud logo
    ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud