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

ionoscloud.nfs.getCluster

Explore with Pulumi AI

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

    Returns information about clusters of Network File Storage (NFS) on IonosCloud.

    By ID

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

const example = ionoscloud.nfs.getCluster({
    location: "location",
    id: "cluster-id",
});

    import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.nfs.get_cluster(location="location",
    id="cluster-id")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nfs.LookupCluster(ctx, &nfs.LookupClusterArgs{
			Location: "location",
			Id:       pulumi.StringRef("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.Nfs.GetCluster.Invoke(new()
    {
        Location = "location",
        Id = "cluster-id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.nfs.NfsFunctions;
import com.pulumi.ionoscloud.nfs.inputs.GetClusterArgs;
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 = NfsFunctions.getCluster(GetClusterArgs.builder()
            .location("location")
            .id("cluster-id")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ionoscloud:nfs:getCluster
      arguments:
        location: location
        id: cluster-id

    By Name

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

const example = ionoscloud.nfs.getCluster({
    location: "location",
    name: "partial-name",
    partialMatch: true,
});

    import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.nfs.get_cluster(location="location",
    name="partial-name",
    partial_match=True)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nfs.LookupCluster(ctx, &nfs.LookupClusterArgs{
			Location:     "location",
			Name:         pulumi.StringRef("partial-name"),
			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.Nfs.GetCluster.Invoke(new()
    {
        Location = "location",
        Name = "partial-name",
        PartialMatch = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.nfs.NfsFunctions;
import com.pulumi.ionoscloud.nfs.inputs.GetClusterArgs;
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 = NfsFunctions.getCluster(GetClusterArgs.builder()
            .location("location")
            .name("partial-name")
            .partialMatch(true)
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ionoscloud:nfs:getCluster
      arguments:
        location: location
        name: partial-name
        partialMatch: true

    Using getCluster

    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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(id: Optional[str] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                partial_match: Optional[bool] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(id: Optional[pulumi.Input[str]] = None,
                location: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                partial_match: Optional[pulumi.Input[bool]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: ionoscloud:nfs/getCluster:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    The location where the Network File Storage cluster is located.
    Id string
    ID of the Network File Storage cluster.
    Name string
    Name of the Network File Storage cluster.
    PartialMatch bool
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    Location string
    The location where the Network File Storage cluster is located.
    Id string
    ID of the Network File Storage cluster.
    Name string
    Name of the Network File Storage cluster.
    PartialMatch bool
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    location String
    The location where the Network File Storage cluster is located.
    id String
    ID of the Network File Storage cluster.
    name String
    Name of the Network File Storage cluster.
    partialMatch Boolean
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    location string
    The location where the Network File Storage cluster is located.
    id string
    ID of the Network File Storage cluster.
    name string
    Name of the Network File Storage cluster.
    partialMatch boolean
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    location str
    The location where the Network File Storage cluster is located.
    id str
    ID of the Network File Storage cluster.
    name str
    Name of the Network File Storage cluster.
    partial_match bool
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    location String
    The location where the Network File Storage cluster is located.
    id String
    ID of the Network File Storage cluster.
    name String
    Name of the Network File Storage cluster.
    partialMatch Boolean
    Whether partial matching is allowed or not when using the name filter. Defaults to false.

    getCluster Result

    The following output properties are available:

    Connections List<Ionoscloud.GetClusterConnection>
    A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
    Id string
    The ID of the Network File Storage cluster.
    Location string
    The location where the Network File Storage cluster is located.
    Name string
    The name of the Network File Storage cluster.
    Nfs List<Ionoscloud.GetClusterNf>
    The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
    Size int
    The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
    PartialMatch bool
    Connections []GetClusterConnection
    A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
    Id string
    The ID of the Network File Storage cluster.
    Location string
    The location where the Network File Storage cluster is located.
    Name string
    The name of the Network File Storage cluster.
    Nfs []GetClusterNf
    The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
    Size int
    The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
    PartialMatch bool
    connections List<GetClusterConnection>
    A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
    id String
    The ID of the Network File Storage cluster.
    location String
    The location where the Network File Storage cluster is located.
    name String
    The name of the Network File Storage cluster.
    nfs List<GetClusterNf>
    The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
    size Integer
    The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
    partialMatch Boolean
    connections GetClusterConnection[]
    A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
    id string
    The ID of the Network File Storage cluster.
    location string
    The location where the Network File Storage cluster is located.
    name string
    The name of the Network File Storage cluster.
    nfs GetClusterNf[]
    The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
    size number
    The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
    partialMatch boolean
    connections Sequence[GetClusterConnection]
    A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
    id str
    The ID of the Network File Storage cluster.
    location str
    The location where the Network File Storage cluster is located.
    name str
    The name of the Network File Storage cluster.
    nfs Sequence[GetClusterNf]
    The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
    size int
    The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
    partial_match bool
    connections List<Property Map>
    A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
    id String
    The ID of the Network File Storage cluster.
    location String
    The location where the Network File Storage cluster is located.
    name String
    The name of the Network File Storage cluster.
    nfs List<Property Map>
    The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
    size Number
    The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
    partialMatch Boolean

    Supporting Types

    GetClusterConnection

    DatacenterId string
    The ID of the datacenter where the Network File Storage cluster is located.
    IpAddress string
    The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
    Lan string
    The Private LAN to which the Network File Storage cluster must be connected.
    DatacenterId string
    The ID of the datacenter where the Network File Storage cluster is located.
    IpAddress string
    The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
    Lan string
    The Private LAN to which the Network File Storage cluster must be connected.
    datacenterId String
    The ID of the datacenter where the Network File Storage cluster is located.
    ipAddress String
    The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
    lan String
    The Private LAN to which the Network File Storage cluster must be connected.
    datacenterId string
    The ID of the datacenter where the Network File Storage cluster is located.
    ipAddress string
    The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
    lan string
    The Private LAN to which the Network File Storage cluster must be connected.
    datacenter_id str
    The ID of the datacenter where the Network File Storage cluster is located.
    ip_address str
    The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
    lan str
    The Private LAN to which the Network File Storage cluster must be connected.
    datacenterId String
    The ID of the datacenter where the Network File Storage cluster is located.
    ipAddress String
    The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
    lan String
    The Private LAN to which the Network File Storage cluster must be connected.

    GetClusterNf

    MinVersion string
    The minimum supported version of the NFS cluster. Default is 4.2
    MinVersion string
    The minimum supported version of the NFS cluster. Default is 4.2
    minVersion String
    The minimum supported version of the NFS cluster. Default is 4.2
    minVersion string
    The minimum supported version of the NFS cluster. Default is 4.2
    min_version str
    The minimum supported version of the NFS cluster. Default is 4.2
    minVersion String
    The minimum supported version of the NFS cluster. Default is 4.2

    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