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

ionoscloud.NfsShare

Explore with Pulumi AI

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

    Creates and manages Network File Storage (NFS) Share objects on IonosCloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ionoscloud from "@pulumi/ionoscloud";
    
    // Basic example
    const nfsDc = new ionoscloud.Datacenter("nfsDc", {
        location: "de/txl",
        description: "Datacenter Description",
        secAuthProtection: false,
    });
    const nfsLan = new ionoscloud.Lan("nfsLan", {
        datacenterId: nfsDc.datacenterId,
        "public": false,
    });
    const exampleNfsCluster = new ionoscloud.NfsCluster("exampleNfsCluster", {
        location: "de/txl",
        size: 2,
        nfs: {
            minVersion: "4.2",
        },
        connections: {
            datacenterId: nfsDc.datacenterId,
            ipAddress: "192.168.100.10/24",
            lan: nfsLan.lanId,
        },
    });
    const exampleNfsShare = new ionoscloud.NfsShare("exampleNfsShare", {
        location: "de/txl",
        clusterId: exampleNfsCluster.id,
        quota: 512,
        gid: 512,
        uid: 512,
        clientGroups: [{
            description: "Client Group 1",
            ipNetworks: ["10.234.50.0/24"],
            hosts: ["10.234.62.123"],
            nfs: {
                squash: "all-anonymous",
            },
        }],
    });
    
    import pulumi
    import pulumi_ionoscloud as ionoscloud
    
    # Basic example
    nfs_dc = ionoscloud.Datacenter("nfsDc",
        location="de/txl",
        description="Datacenter Description",
        sec_auth_protection=False)
    nfs_lan = ionoscloud.Lan("nfsLan",
        datacenter_id=nfs_dc.datacenter_id,
        public=False)
    example_nfs_cluster = ionoscloud.NfsCluster("exampleNfsCluster",
        location="de/txl",
        size=2,
        nfs={
            "min_version": "4.2",
        },
        connections={
            "datacenter_id": nfs_dc.datacenter_id,
            "ip_address": "192.168.100.10/24",
            "lan": nfs_lan.lan_id,
        })
    example_nfs_share = ionoscloud.NfsShare("exampleNfsShare",
        location="de/txl",
        cluster_id=example_nfs_cluster.id,
        quota=512,
        gid=512,
        uid=512,
        client_groups=[{
            "description": "Client Group 1",
            "ip_networks": ["10.234.50.0/24"],
            "hosts": ["10.234.62.123"],
            "nfs": {
                "squash": "all-anonymous",
            },
        }])
    
    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 {
    		// Basic example
    		nfsDc, err := ionoscloud.NewDatacenter(ctx, "nfsDc", &ionoscloud.DatacenterArgs{
    			Location:          pulumi.String("de/txl"),
    			Description:       pulumi.String("Datacenter Description"),
    			SecAuthProtection: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		nfsLan, err := ionoscloud.NewLan(ctx, "nfsLan", &ionoscloud.LanArgs{
    			DatacenterId: nfsDc.DatacenterId,
    			Public:       pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		exampleNfsCluster, err := ionoscloud.NewNfsCluster(ctx, "exampleNfsCluster", &ionoscloud.NfsClusterArgs{
    			Location: pulumi.String("de/txl"),
    			Size:     pulumi.Float64(2),
    			Nfs: &ionoscloud.NfsClusterNfsArgs{
    				MinVersion: pulumi.String("4.2"),
    			},
    			Connections: &ionoscloud.NfsClusterConnectionsArgs{
    				DatacenterId: nfsDc.DatacenterId,
    				IpAddress:    pulumi.String("192.168.100.10/24"),
    				Lan:          nfsLan.LanId,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ionoscloud.NewNfsShare(ctx, "exampleNfsShare", &ionoscloud.NfsShareArgs{
    			Location:  pulumi.String("de/txl"),
    			ClusterId: exampleNfsCluster.ID(),
    			Quota:     pulumi.Float64(512),
    			Gid:       pulumi.Float64(512),
    			Uid:       pulumi.Float64(512),
    			ClientGroups: ionoscloud.NfsShareClientGroupArray{
    				&ionoscloud.NfsShareClientGroupArgs{
    					Description: pulumi.String("Client Group 1"),
    					IpNetworks: pulumi.StringArray{
    						pulumi.String("10.234.50.0/24"),
    					},
    					Hosts: pulumi.StringArray{
    						pulumi.String("10.234.62.123"),
    					},
    					Nfs: &ionoscloud.NfsShareClientGroupNfsArgs{
    						Squash: pulumi.String("all-anonymous"),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ionoscloud = Pulumi.Ionoscloud;
    
    return await Deployment.RunAsync(() => 
    {
        // Basic example
        var nfsDc = new Ionoscloud.Datacenter("nfsDc", new()
        {
            Location = "de/txl",
            Description = "Datacenter Description",
            SecAuthProtection = false,
        });
    
        var nfsLan = new Ionoscloud.Lan("nfsLan", new()
        {
            DatacenterId = nfsDc.DatacenterId,
            Public = false,
        });
    
        var exampleNfsCluster = new Ionoscloud.NfsCluster("exampleNfsCluster", new()
        {
            Location = "de/txl",
            Size = 2,
            Nfs = new Ionoscloud.Inputs.NfsClusterNfsArgs
            {
                MinVersion = "4.2",
            },
            Connections = new Ionoscloud.Inputs.NfsClusterConnectionsArgs
            {
                DatacenterId = nfsDc.DatacenterId,
                IpAddress = "192.168.100.10/24",
                Lan = nfsLan.LanId,
            },
        });
    
        var exampleNfsShare = new Ionoscloud.NfsShare("exampleNfsShare", new()
        {
            Location = "de/txl",
            ClusterId = exampleNfsCluster.Id,
            Quota = 512,
            Gid = 512,
            Uid = 512,
            ClientGroups = new[]
            {
                new Ionoscloud.Inputs.NfsShareClientGroupArgs
                {
                    Description = "Client Group 1",
                    IpNetworks = new[]
                    {
                        "10.234.50.0/24",
                    },
                    Hosts = new[]
                    {
                        "10.234.62.123",
                    },
                    Nfs = new Ionoscloud.Inputs.NfsShareClientGroupNfsArgs
                    {
                        Squash = "all-anonymous",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ionoscloud.Datacenter;
    import com.pulumi.ionoscloud.DatacenterArgs;
    import com.pulumi.ionoscloud.Lan;
    import com.pulumi.ionoscloud.LanArgs;
    import com.pulumi.ionoscloud.NfsCluster;
    import com.pulumi.ionoscloud.NfsClusterArgs;
    import com.pulumi.ionoscloud.inputs.NfsClusterNfsArgs;
    import com.pulumi.ionoscloud.inputs.NfsClusterConnectionsArgs;
    import com.pulumi.ionoscloud.NfsShare;
    import com.pulumi.ionoscloud.NfsShareArgs;
    import com.pulumi.ionoscloud.inputs.NfsShareClientGroupArgs;
    import com.pulumi.ionoscloud.inputs.NfsShareClientGroupNfsArgs;
    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) {
            // Basic example
            var nfsDc = new Datacenter("nfsDc", DatacenterArgs.builder()
                .location("de/txl")
                .description("Datacenter Description")
                .secAuthProtection(false)
                .build());
    
            var nfsLan = new Lan("nfsLan", LanArgs.builder()
                .datacenterId(nfsDc.datacenterId())
                .public_(false)
                .build());
    
            var exampleNfsCluster = new NfsCluster("exampleNfsCluster", NfsClusterArgs.builder()
                .location("de/txl")
                .size(2)
                .nfs(NfsClusterNfsArgs.builder()
                    .minVersion("4.2")
                    .build())
                .connections(NfsClusterConnectionsArgs.builder()
                    .datacenterId(nfsDc.datacenterId())
                    .ipAddress("192.168.100.10/24")
                    .lan(nfsLan.lanId())
                    .build())
                .build());
    
            var exampleNfsShare = new NfsShare("exampleNfsShare", NfsShareArgs.builder()
                .location("de/txl")
                .clusterId(exampleNfsCluster.id())
                .quota(512)
                .gid(512)
                .uid(512)
                .clientGroups(NfsShareClientGroupArgs.builder()
                    .description("Client Group 1")
                    .ipNetworks("10.234.50.0/24")
                    .hosts("10.234.62.123")
                    .nfs(NfsShareClientGroupNfsArgs.builder()
                        .squash("all-anonymous")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      # Basic example
      nfsDc:
        type: ionoscloud:Datacenter
        properties:
          location: de/txl
          description: Datacenter Description
          secAuthProtection: false
      nfsLan:
        type: ionoscloud:Lan
        properties:
          datacenterId: ${nfsDc.datacenterId}
          public: false
      exampleNfsCluster:
        type: ionoscloud:NfsCluster
        properties:
          location: de/txl
          size: 2
          nfs:
            minVersion: '4.2'
          connections:
            datacenterId: ${nfsDc.datacenterId}
            ipAddress: 192.168.100.10/24
            lan: ${nfsLan.lanId}
      exampleNfsShare:
        type: ionoscloud:NfsShare
        properties:
          location: de/txl
          clusterId: ${exampleNfsCluster.id}
          quota: 512
          gid: 512
          uid: 512
          clientGroups:
            - description: Client Group 1
              ipNetworks:
                - 10.234.50.0/24
              hosts:
                - 10.234.62.123
              nfs:
                squash: all-anonymous
    

    Create NfsShare Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NfsShare(name: string, args: NfsShareArgs, opts?: CustomResourceOptions);
    @overload
    def NfsShare(resource_name: str,
                 args: NfsShareArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def NfsShare(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 client_groups: Optional[Sequence[NfsShareClientGroupArgs]] = None,
                 cluster_id: Optional[str] = None,
                 gid: Optional[float] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 quota: Optional[float] = None,
                 timeouts: Optional[NfsShareTimeoutsArgs] = None,
                 uid: Optional[float] = None)
    func NewNfsShare(ctx *Context, name string, args NfsShareArgs, opts ...ResourceOption) (*NfsShare, error)
    public NfsShare(string name, NfsShareArgs args, CustomResourceOptions? opts = null)
    public NfsShare(String name, NfsShareArgs args)
    public NfsShare(String name, NfsShareArgs args, CustomResourceOptions options)
    
    type: ionoscloud:NfsShare
    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 NfsShareArgs
    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 NfsShareArgs
    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 NfsShareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NfsShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NfsShareArgs
    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 nfsShareResource = new Ionoscloud.NfsShare("nfsShareResource", new()
    {
        ClientGroups = new[]
        {
            new Ionoscloud.Inputs.NfsShareClientGroupArgs
            {
                Hosts = new[]
                {
                    "string",
                },
                IpNetworks = new[]
                {
                    "string",
                },
                Description = "string",
                Nfs = new Ionoscloud.Inputs.NfsShareClientGroupNfsArgs
                {
                    Squash = "string",
                },
            },
        },
        ClusterId = "string",
        Gid = 0,
        Location = "string",
        Name = "string",
        Quota = 0,
        Timeouts = new Ionoscloud.Inputs.NfsShareTimeoutsArgs
        {
            Create = "string",
            Default = "string",
            Delete = "string",
            Update = "string",
        },
        Uid = 0,
    });
    
    example, err := ionoscloud.NewNfsShare(ctx, "nfsShareResource", &ionoscloud.NfsShareArgs{
    	ClientGroups: ionoscloud.NfsShareClientGroupArray{
    		&ionoscloud.NfsShareClientGroupArgs{
    			Hosts: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			IpNetworks: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Description: pulumi.String("string"),
    			Nfs: &ionoscloud.NfsShareClientGroupNfsArgs{
    				Squash: pulumi.String("string"),
    			},
    		},
    	},
    	ClusterId: pulumi.String("string"),
    	Gid:       pulumi.Float64(0),
    	Location:  pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Quota:     pulumi.Float64(0),
    	Timeouts: &ionoscloud.NfsShareTimeoutsArgs{
    		Create:  pulumi.String("string"),
    		Default: pulumi.String("string"),
    		Delete:  pulumi.String("string"),
    		Update:  pulumi.String("string"),
    	},
    	Uid: pulumi.Float64(0),
    })
    
    var nfsShareResource = new NfsShare("nfsShareResource", NfsShareArgs.builder()
        .clientGroups(NfsShareClientGroupArgs.builder()
            .hosts("string")
            .ipNetworks("string")
            .description("string")
            .nfs(NfsShareClientGroupNfsArgs.builder()
                .squash("string")
                .build())
            .build())
        .clusterId("string")
        .gid(0)
        .location("string")
        .name("string")
        .quota(0)
        .timeouts(NfsShareTimeoutsArgs.builder()
            .create("string")
            .default_("string")
            .delete("string")
            .update("string")
            .build())
        .uid(0)
        .build());
    
    nfs_share_resource = ionoscloud.NfsShare("nfsShareResource",
        client_groups=[{
            "hosts": ["string"],
            "ip_networks": ["string"],
            "description": "string",
            "nfs": {
                "squash": "string",
            },
        }],
        cluster_id="string",
        gid=0,
        location="string",
        name="string",
        quota=0,
        timeouts={
            "create": "string",
            "default": "string",
            "delete": "string",
            "update": "string",
        },
        uid=0)
    
    const nfsShareResource = new ionoscloud.NfsShare("nfsShareResource", {
        clientGroups: [{
            hosts: ["string"],
            ipNetworks: ["string"],
            description: "string",
            nfs: {
                squash: "string",
            },
        }],
        clusterId: "string",
        gid: 0,
        location: "string",
        name: "string",
        quota: 0,
        timeouts: {
            create: "string",
            "default": "string",
            "delete": "string",
            update: "string",
        },
        uid: 0,
    });
    
    type: ionoscloud:NfsShare
    properties:
        clientGroups:
            - description: string
              hosts:
                - string
              ipNetworks:
                - string
              nfs:
                squash: string
        clusterId: string
        gid: 0
        location: string
        name: string
        quota: 0
        timeouts:
            create: string
            default: string
            delete: string
            update: string
        uid: 0
    

    NfsShare 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 NfsShare resource accepts the following input properties:

    ClientGroups List<NfsShareClientGroup>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    ClusterId string
    The ID of the Network File Storage Cluster.
    Gid double
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    Location string
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    Name string
    The directory being exported.
    Quota double
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    Timeouts NfsShareTimeouts
    Uid double
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    ClientGroups []NfsShareClientGroupArgs
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    ClusterId string
    The ID of the Network File Storage Cluster.
    Gid float64
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    Location string
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    Name string
    The directory being exported.
    Quota float64
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    Timeouts NfsShareTimeoutsArgs
    Uid float64
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    clientGroups List<NfsShareClientGroup>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    clusterId String
    The ID of the Network File Storage Cluster.
    gid Double
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    location String
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    name String
    The directory being exported.
    quota Double
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    timeouts NfsShareTimeouts
    uid Double
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    clientGroups NfsShareClientGroup[]
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    clusterId string
    The ID of the Network File Storage Cluster.
    gid number
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    location string
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    name string
    The directory being exported.
    quota number
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    timeouts NfsShareTimeouts
    uid number
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    client_groups Sequence[NfsShareClientGroupArgs]
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    cluster_id str
    The ID of the Network File Storage Cluster.
    gid float
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    location str
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    name str
    The directory being exported.
    quota float
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    timeouts NfsShareTimeoutsArgs
    uid float
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    clientGroups List<Property Map>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    clusterId String
    The ID of the Network File Storage Cluster.
    gid Number
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    location String
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    name String
    The directory being exported.
    quota Number
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    timeouts Property Map
    uid Number
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NfsShare resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    NfsPath string
    Path to the NFS export. The NFS path is the path to the directory being exported.
    Id string
    The provider-assigned unique ID for this managed resource.
    NfsPath string
    Path to the NFS export. The NFS path is the path to the directory being exported.
    id String
    The provider-assigned unique ID for this managed resource.
    nfsPath String
    Path to the NFS export. The NFS path is the path to the directory being exported.
    id string
    The provider-assigned unique ID for this managed resource.
    nfsPath string
    Path to the NFS export. The NFS path is the path to the directory being exported.
    id str
    The provider-assigned unique ID for this managed resource.
    nfs_path str
    Path to the NFS export. The NFS path is the path to the directory being exported.
    id String
    The provider-assigned unique ID for this managed resource.
    nfsPath String
    Path to the NFS export. The NFS path is the path to the directory being exported.

    Look up Existing NfsShare Resource

    Get an existing NfsShare 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?: NfsShareState, opts?: CustomResourceOptions): NfsShare
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            client_groups: Optional[Sequence[NfsShareClientGroupArgs]] = None,
            cluster_id: Optional[str] = None,
            gid: Optional[float] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            nfs_path: Optional[str] = None,
            quota: Optional[float] = None,
            timeouts: Optional[NfsShareTimeoutsArgs] = None,
            uid: Optional[float] = None) -> NfsShare
    func GetNfsShare(ctx *Context, name string, id IDInput, state *NfsShareState, opts ...ResourceOption) (*NfsShare, error)
    public static NfsShare Get(string name, Input<string> id, NfsShareState? state, CustomResourceOptions? opts = null)
    public static NfsShare get(String name, Output<String> id, NfsShareState state, CustomResourceOptions options)
    resources:  _:    type: ionoscloud:NfsShare    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.
    The following state arguments are supported:
    ClientGroups List<NfsShareClientGroup>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    ClusterId string
    The ID of the Network File Storage Cluster.
    Gid double
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    Location string
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    Name string
    The directory being exported.
    NfsPath string
    Path to the NFS export. The NFS path is the path to the directory being exported.
    Quota double
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    Timeouts NfsShareTimeouts
    Uid double
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    ClientGroups []NfsShareClientGroupArgs
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    ClusterId string
    The ID of the Network File Storage Cluster.
    Gid float64
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    Location string
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    Name string
    The directory being exported.
    NfsPath string
    Path to the NFS export. The NFS path is the path to the directory being exported.
    Quota float64
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    Timeouts NfsShareTimeoutsArgs
    Uid float64
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    clientGroups List<NfsShareClientGroup>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    clusterId String
    The ID of the Network File Storage Cluster.
    gid Double
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    location String
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    name String
    The directory being exported.
    nfsPath String
    Path to the NFS export. The NFS path is the path to the directory being exported.
    quota Double
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    timeouts NfsShareTimeouts
    uid Double
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    clientGroups NfsShareClientGroup[]
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    clusterId string
    The ID of the Network File Storage Cluster.
    gid number
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    location string
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    name string
    The directory being exported.
    nfsPath string
    Path to the NFS export. The NFS path is the path to the directory being exported.
    quota number
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    timeouts NfsShareTimeouts
    uid number
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    client_groups Sequence[NfsShareClientGroupArgs]
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    cluster_id str
    The ID of the Network File Storage Cluster.
    gid float
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    location str
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    name str
    The directory being exported.
    nfs_path str
    Path to the NFS export. The NFS path is the path to the directory being exported.
    quota float
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    timeouts NfsShareTimeoutsArgs
    uid float
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    clientGroups List<Property Map>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each group includes:
    clusterId String
    The ID of the Network File Storage Cluster.
    gid Number
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    location String
    The location of the Network File Storage Cluster. If this is not set and if no value is provided for the IONOS_API_URL env var, the default location will be: de/fra.
    name String
    The directory being exported.
    nfsPath String
    Path to the NFS export. The NFS path is the path to the directory being exported.
    quota Number
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0. Default is 0.
    timeouts Property Map
    uid Number
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.

    Supporting Types

    NfsShareClientGroup, NfsShareClientGroupArgs

    Hosts List<string>
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    IpNetworks List<string>
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    Description string
    Optional description for the clients groups.
    Nfs NfsShareClientGroupNfs
    NFS specific configurations. Each configuration includes:
    Hosts []string
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    IpNetworks []string
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    Description string
    Optional description for the clients groups.
    Nfs NfsShareClientGroupNfs
    NFS specific configurations. Each configuration includes:
    hosts List<String>
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    ipNetworks List<String>
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    description String
    Optional description for the clients groups.
    nfs NfsShareClientGroupNfs
    NFS specific configurations. Each configuration includes:
    hosts string[]
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    ipNetworks string[]
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    description string
    Optional description for the clients groups.
    nfs NfsShareClientGroupNfs
    NFS specific configurations. Each configuration includes:
    hosts Sequence[str]
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    ip_networks Sequence[str]
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    description str
    Optional description for the clients groups.
    nfs NfsShareClientGroupNfs
    NFS specific configurations. Each configuration includes:
    hosts List<String>
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    ipNetworks List<String>
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    description String
    Optional description for the clients groups.
    nfs Property Map
    NFS specific configurations. Each configuration includes:

    NfsShareClientGroupNfs, NfsShareClientGroupNfsArgs

    Squash string
    The squash mode for the export. The squash mode can be:
    Squash string
    The squash mode for the export. The squash mode can be:
    squash String
    The squash mode for the export. The squash mode can be:
    squash string
    The squash mode for the export. The squash mode can be:
    squash str
    The squash mode for the export. The squash mode can be:
    squash String
    The squash mode for the export. The squash mode can be:

    NfsShareTimeouts, NfsShareTimeoutsArgs

    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

    Import

    A Network File Storage Share resource can be imported using its location, cluster_id and resource id:

    $ pulumi import ionoscloud:index/nfsShare:NfsShare name location:cluster_id:resource_id
    

    To learn more about importing existing cloud resources, see Importing resources.

    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