1. Packages
  2. Gcore Provider
  3. API Docs
  4. FileShare
gcore 0.29.1 published on Wednesday, Sep 10, 2025 by g-core

gcore.FileShare

Explore with Pulumi AI

gcore logo
gcore 0.29.1 published on Wednesday, Sep 10, 2025 by g-core

    Represents a file share (NFS) in Gcore Cloud.

    Example Usage

    VAST File Share Example

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const project = gcore.getProject({
        name: "Default",
    });
    const region = gcore.getRegion({
        name: "Sines-2",
    });
    const fileShareVast = new gcore.FileShare("fileShareVast", {
        size: 10,
        projectId: project.then(project => project.id),
        regionId: region.then(region => region.id),
        typeName: "vast",
        protocol: "NFS",
    });
    
    import pulumi
    import pulumi_gcore as gcore
    
    project = gcore.get_project(name="Default")
    region = gcore.get_region(name="Sines-2")
    file_share_vast = gcore.FileShare("fileShareVast",
        size=10,
        project_id=project.id,
        region_id=region.id,
        type_name="vast",
        protocol="NFS")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		project, err := gcore.GetProject(ctx, &gcore.GetProjectArgs{
    			Name: "Default",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		region, err := gcore.GetRegion(ctx, &gcore.GetRegionArgs{
    			Name: "Sines-2",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = gcore.NewFileShare(ctx, "fileShareVast", &gcore.FileShareArgs{
    			Size:      pulumi.Float64(10),
    			ProjectId: pulumi.String(project.Id),
    			RegionId:  pulumi.String(region.Id),
    			TypeName:  pulumi.String("vast"),
    			Protocol:  pulumi.String("NFS"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var project = Gcore.GetProject.Invoke(new()
        {
            Name = "Default",
        });
    
        var region = Gcore.GetRegion.Invoke(new()
        {
            Name = "Sines-2",
        });
    
        var fileShareVast = new Gcore.FileShare("fileShareVast", new()
        {
            Size = 10,
            ProjectId = project.Apply(getProjectResult => getProjectResult.Id),
            RegionId = region.Apply(getRegionResult => getRegionResult.Id),
            TypeName = "vast",
            Protocol = "NFS",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetProjectArgs;
    import com.pulumi.gcore.inputs.GetRegionArgs;
    import com.pulumi.gcore.FileShare;
    import com.pulumi.gcore.FileShareArgs;
    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 project = GcoreFunctions.getProject(GetProjectArgs.builder()
                .name("Default")
                .build());
    
            final var region = GcoreFunctions.getRegion(GetRegionArgs.builder()
                .name("Sines-2")
                .build());
    
            var fileShareVast = new FileShare("fileShareVast", FileShareArgs.builder()
                .size(10)
                .projectId(project.applyValue(getProjectResult -> getProjectResult.id()))
                .regionId(region.applyValue(getRegionResult -> getRegionResult.id()))
                .typeName("vast")
                .protocol("NFS")
                .build());
    
        }
    }
    
    resources:
      fileShareVast:
        type: gcore:FileShare
        properties:
          size: 10
          projectId: ${project.id}
          regionId: ${region.id}
          typeName: vast
          protocol: NFS
    variables:
      project:
        fn::invoke:
          function: gcore:getProject
          arguments:
            name: Default
      region:
        fn::invoke:
          function: gcore:getRegion
          arguments:
            name: Sines-2
    

    Standard File Share Example

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const project = gcore.getProject({
        name: "Default",
    });
    const region = gcore.getRegion({
        name: "Luxembourg-2",
    });
    const fileShareStandard = new gcore.FileShare("fileShareStandard", {
        size: 20,
        projectId: project.then(project => project.id),
        regionId: region.then(region => region.id),
        typeName: "standard",
        protocol: "NFS",
        network: {
            networkId: "378ba73d-16c5-4a4e-a755-d9406dd73e63",
        },
        accesses: [{
            ipAddress: "10.95.129.0/24",
            accessMode: "rw",
        }],
    });
    
    import pulumi
    import pulumi_gcore as gcore
    
    project = gcore.get_project(name="Default")
    region = gcore.get_region(name="Luxembourg-2")
    file_share_standard = gcore.FileShare("fileShareStandard",
        size=20,
        project_id=project.id,
        region_id=region.id,
        type_name="standard",
        protocol="NFS",
        network={
            "network_id": "378ba73d-16c5-4a4e-a755-d9406dd73e63",
        },
        accesses=[{
            "ip_address": "10.95.129.0/24",
            "access_mode": "rw",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		project, err := gcore.GetProject(ctx, &gcore.GetProjectArgs{
    			Name: "Default",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		region, err := gcore.GetRegion(ctx, &gcore.GetRegionArgs{
    			Name: "Luxembourg-2",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = gcore.NewFileShare(ctx, "fileShareStandard", &gcore.FileShareArgs{
    			Size:      pulumi.Float64(20),
    			ProjectId: pulumi.String(project.Id),
    			RegionId:  pulumi.String(region.Id),
    			TypeName:  pulumi.String("standard"),
    			Protocol:  pulumi.String("NFS"),
    			Network: &gcore.FileShareNetworkArgs{
    				NetworkId: pulumi.String("378ba73d-16c5-4a4e-a755-d9406dd73e63"),
    			},
    			Accesses: gcore.FileShareAccessArray{
    				&gcore.FileShareAccessArgs{
    					IpAddress:  pulumi.String("10.95.129.0/24"),
    					AccessMode: pulumi.String("rw"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var project = Gcore.GetProject.Invoke(new()
        {
            Name = "Default",
        });
    
        var region = Gcore.GetRegion.Invoke(new()
        {
            Name = "Luxembourg-2",
        });
    
        var fileShareStandard = new Gcore.FileShare("fileShareStandard", new()
        {
            Size = 20,
            ProjectId = project.Apply(getProjectResult => getProjectResult.Id),
            RegionId = region.Apply(getRegionResult => getRegionResult.Id),
            TypeName = "standard",
            Protocol = "NFS",
            Network = new Gcore.Inputs.FileShareNetworkArgs
            {
                NetworkId = "378ba73d-16c5-4a4e-a755-d9406dd73e63",
            },
            Accesses = new[]
            {
                new Gcore.Inputs.FileShareAccessArgs
                {
                    IpAddress = "10.95.129.0/24",
                    AccessMode = "rw",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetProjectArgs;
    import com.pulumi.gcore.inputs.GetRegionArgs;
    import com.pulumi.gcore.FileShare;
    import com.pulumi.gcore.FileShareArgs;
    import com.pulumi.gcore.inputs.FileShareNetworkArgs;
    import com.pulumi.gcore.inputs.FileShareAccessArgs;
    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 project = GcoreFunctions.getProject(GetProjectArgs.builder()
                .name("Default")
                .build());
    
            final var region = GcoreFunctions.getRegion(GetRegionArgs.builder()
                .name("Luxembourg-2")
                .build());
    
            var fileShareStandard = new FileShare("fileShareStandard", FileShareArgs.builder()
                .size(20)
                .projectId(project.applyValue(getProjectResult -> getProjectResult.id()))
                .regionId(region.applyValue(getRegionResult -> getRegionResult.id()))
                .typeName("standard")
                .protocol("NFS")
                .network(FileShareNetworkArgs.builder()
                    .networkId("378ba73d-16c5-4a4e-a755-d9406dd73e63")
                    .build())
                .accesses(FileShareAccessArgs.builder()
                    .ipAddress("10.95.129.0/24")
                    .accessMode("rw")
                    .build())
                .build());
    
        }
    }
    
    resources:
      fileShareStandard:
        type: gcore:FileShare
        properties:
          size: 20
          projectId: ${project.id}
          regionId: ${region.id}
          typeName: standard
          protocol: NFS
          network:
            networkId: 378ba73d-16c5-4a4e-a755-d9406dd73e63
          accesses:
            - ipAddress: 10.95.129.0/24
              accessMode: rw
    variables:
      project:
        fn::invoke:
          function: gcore:getProject
          arguments:
            name: Default
      region:
        fn::invoke:
          function: gcore:getRegion
          arguments:
            name: Luxembourg-2
    

    Create FileShare Resource

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

    Constructor syntax

    new FileShare(name: string, args: FileShareArgs, opts?: CustomResourceOptions);
    @overload
    def FileShare(resource_name: str,
                  args: FileShareArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def FileShare(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  protocol: Optional[str] = None,
                  size: Optional[float] = None,
                  type_name: Optional[str] = None,
                  accesses: Optional[Sequence[FileShareAccessArgs]] = None,
                  file_share_id: Optional[str] = None,
                  name: Optional[str] = None,
                  network: Optional[FileShareNetworkArgs] = None,
                  project_id: Optional[float] = None,
                  project_name: Optional[str] = None,
                  region_id: Optional[float] = None,
                  region_name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewFileShare(ctx *Context, name string, args FileShareArgs, opts ...ResourceOption) (*FileShare, error)
    public FileShare(string name, FileShareArgs args, CustomResourceOptions? opts = null)
    public FileShare(String name, FileShareArgs args)
    public FileShare(String name, FileShareArgs args, CustomResourceOptions options)
    
    type: gcore:FileShare
    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 FileShareArgs
    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 FileShareArgs
    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 FileShareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileShareArgs
    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 fileShareResource = new Gcore.FileShare("fileShareResource", new()
    {
        Protocol = "string",
        Size = 0,
        TypeName = "string",
        Accesses = new[]
        {
            new Gcore.Inputs.FileShareAccessArgs
            {
                AccessMode = "string",
                IpAddress = "string",
            },
        },
        FileShareId = "string",
        Name = "string",
        Network = new Gcore.Inputs.FileShareNetworkArgs
        {
            NetworkId = "string",
            SubnetId = "string",
        },
        ProjectId = 0,
        ProjectName = "string",
        RegionId = 0,
        RegionName = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := gcore.NewFileShare(ctx, "fileShareResource", &gcore.FileShareArgs{
    	Protocol: pulumi.String("string"),
    	Size:     pulumi.Float64(0),
    	TypeName: pulumi.String("string"),
    	Accesses: gcore.FileShareAccessArray{
    		&gcore.FileShareAccessArgs{
    			AccessMode: pulumi.String("string"),
    			IpAddress:  pulumi.String("string"),
    		},
    	},
    	FileShareId: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Network: &gcore.FileShareNetworkArgs{
    		NetworkId: pulumi.String("string"),
    		SubnetId:  pulumi.String("string"),
    	},
    	ProjectId:   pulumi.Float64(0),
    	ProjectName: pulumi.String("string"),
    	RegionId:    pulumi.Float64(0),
    	RegionName:  pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var fileShareResource = new FileShare("fileShareResource", FileShareArgs.builder()
        .protocol("string")
        .size(0.0)
        .typeName("string")
        .accesses(FileShareAccessArgs.builder()
            .accessMode("string")
            .ipAddress("string")
            .build())
        .fileShareId("string")
        .name("string")
        .network(FileShareNetworkArgs.builder()
            .networkId("string")
            .subnetId("string")
            .build())
        .projectId(0.0)
        .projectName("string")
        .regionId(0.0)
        .regionName("string")
        .tags(Map.of("string", "string"))
        .build());
    
    file_share_resource = gcore.FileShare("fileShareResource",
        protocol="string",
        size=0,
        type_name="string",
        accesses=[{
            "access_mode": "string",
            "ip_address": "string",
        }],
        file_share_id="string",
        name="string",
        network={
            "network_id": "string",
            "subnet_id": "string",
        },
        project_id=0,
        project_name="string",
        region_id=0,
        region_name="string",
        tags={
            "string": "string",
        })
    
    const fileShareResource = new gcore.FileShare("fileShareResource", {
        protocol: "string",
        size: 0,
        typeName: "string",
        accesses: [{
            accessMode: "string",
            ipAddress: "string",
        }],
        fileShareId: "string",
        name: "string",
        network: {
            networkId: "string",
            subnetId: "string",
        },
        projectId: 0,
        projectName: "string",
        regionId: 0,
        regionName: "string",
        tags: {
            string: "string",
        },
    });
    
    type: gcore:FileShare
    properties:
        accesses:
            - accessMode: string
              ipAddress: string
        fileShareId: string
        name: string
        network:
            networkId: string
            subnetId: string
        projectId: 0
        projectName: string
        protocol: string
        regionId: 0
        regionName: string
        size: 0
        tags:
            string: string
        typeName: string
    

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

    Protocol string
    The protocol used by the file share. Currently, only 'NFS' is supported.
    Size double
    The size of the file share in GB. It must be a positive integer.
    TypeName string
    The type of the file share. Must be one of 'standard' or 'vast'.
    Accesses List<FileShareAccess>
    FileShareId string
    The ID of this resource.
    Name string
    The name of the file share. It must be unique within the project and region.
    Network FileShareNetwork
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    ProjectId double
    Project ID, only one of projectid or projectname should be set
    ProjectName string
    Project name, only one of projectid or projectname should be set
    RegionId double
    Region ID, only one of regionid or regionname should be set
    RegionName string
    Region name, only one of regionid or regionname should be set
    Tags Dictionary<string, string>
    Tags to associate with the file share. Tags are key-value pairs.
    Protocol string
    The protocol used by the file share. Currently, only 'NFS' is supported.
    Size float64
    The size of the file share in GB. It must be a positive integer.
    TypeName string
    The type of the file share. Must be one of 'standard' or 'vast'.
    Accesses []FileShareAccessArgs
    FileShareId string
    The ID of this resource.
    Name string
    The name of the file share. It must be unique within the project and region.
    Network FileShareNetworkArgs
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    ProjectId float64
    Project ID, only one of projectid or projectname should be set
    ProjectName string
    Project name, only one of projectid or projectname should be set
    RegionId float64
    Region ID, only one of regionid or regionname should be set
    RegionName string
    Region name, only one of regionid or regionname should be set
    Tags map[string]string
    Tags to associate with the file share. Tags are key-value pairs.
    protocol String
    The protocol used by the file share. Currently, only 'NFS' is supported.
    size Double
    The size of the file share in GB. It must be a positive integer.
    typeName String
    The type of the file share. Must be one of 'standard' or 'vast'.
    accesses List<FileShareAccess>
    fileShareId String
    The ID of this resource.
    name String
    The name of the file share. It must be unique within the project and region.
    network FileShareNetwork
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    projectId Double
    Project ID, only one of projectid or projectname should be set
    projectName String
    Project name, only one of projectid or projectname should be set
    regionId Double
    Region ID, only one of regionid or regionname should be set
    regionName String
    Region name, only one of regionid or regionname should be set
    tags Map<String,String>
    Tags to associate with the file share. Tags are key-value pairs.
    protocol string
    The protocol used by the file share. Currently, only 'NFS' is supported.
    size number
    The size of the file share in GB. It must be a positive integer.
    typeName string
    The type of the file share. Must be one of 'standard' or 'vast'.
    accesses FileShareAccess[]
    fileShareId string
    The ID of this resource.
    name string
    The name of the file share. It must be unique within the project and region.
    network FileShareNetwork
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    projectId number
    Project ID, only one of projectid or projectname should be set
    projectName string
    Project name, only one of projectid or projectname should be set
    regionId number
    Region ID, only one of regionid or regionname should be set
    regionName string
    Region name, only one of regionid or regionname should be set
    tags {[key: string]: string}
    Tags to associate with the file share. Tags are key-value pairs.
    protocol str
    The protocol used by the file share. Currently, only 'NFS' is supported.
    size float
    The size of the file share in GB. It must be a positive integer.
    type_name str
    The type of the file share. Must be one of 'standard' or 'vast'.
    accesses Sequence[FileShareAccessArgs]
    file_share_id str
    The ID of this resource.
    name str
    The name of the file share. It must be unique within the project and region.
    network FileShareNetworkArgs
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    project_id float
    Project ID, only one of projectid or projectname should be set
    project_name str
    Project name, only one of projectid or projectname should be set
    region_id float
    Region ID, only one of regionid or regionname should be set
    region_name str
    Region name, only one of regionid or regionname should be set
    tags Mapping[str, str]
    Tags to associate with the file share. Tags are key-value pairs.
    protocol String
    The protocol used by the file share. Currently, only 'NFS' is supported.
    size Number
    The size of the file share in GB. It must be a positive integer.
    typeName String
    The type of the file share. Must be one of 'standard' or 'vast'.
    accesses List<Property Map>
    fileShareId String
    The ID of this resource.
    name String
    The name of the file share. It must be unique within the project and region.
    network Property Map
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    projectId Number
    Project ID, only one of projectid or projectname should be set
    projectName String
    Project name, only one of projectid or projectname should be set
    regionId Number
    Region ID, only one of regionid or regionname should be set
    regionName String
    Region name, only one of regionid or regionname should be set
    tags Map<String>
    Tags to associate with the file share. Tags are key-value pairs.

    Outputs

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

    ConnectionPoint string
    The connection point of the file share.
    CreatedAt string
    The creation time of the file share in ISO 8601 format.
    CreatorTaskId string
    The ID of the task that created the file share.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkName string
    The name of the network associated with the file share.
    ShareNetworkName string
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    Status string
    The status of the file share.
    SubnetName string
    The name of the subnet associated with the file share
    ConnectionPoint string
    The connection point of the file share.
    CreatedAt string
    The creation time of the file share in ISO 8601 format.
    CreatorTaskId string
    The ID of the task that created the file share.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkName string
    The name of the network associated with the file share.
    ShareNetworkName string
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    Status string
    The status of the file share.
    SubnetName string
    The name of the subnet associated with the file share
    connectionPoint String
    The connection point of the file share.
    createdAt String
    The creation time of the file share in ISO 8601 format.
    creatorTaskId String
    The ID of the task that created the file share.
    id String
    The provider-assigned unique ID for this managed resource.
    networkName String
    The name of the network associated with the file share.
    shareNetworkName String
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    status String
    The status of the file share.
    subnetName String
    The name of the subnet associated with the file share
    connectionPoint string
    The connection point of the file share.
    createdAt string
    The creation time of the file share in ISO 8601 format.
    creatorTaskId string
    The ID of the task that created the file share.
    id string
    The provider-assigned unique ID for this managed resource.
    networkName string
    The name of the network associated with the file share.
    shareNetworkName string
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    status string
    The status of the file share.
    subnetName string
    The name of the subnet associated with the file share
    connection_point str
    The connection point of the file share.
    created_at str
    The creation time of the file share in ISO 8601 format.
    creator_task_id str
    The ID of the task that created the file share.
    id str
    The provider-assigned unique ID for this managed resource.
    network_name str
    The name of the network associated with the file share.
    share_network_name str
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    status str
    The status of the file share.
    subnet_name str
    The name of the subnet associated with the file share
    connectionPoint String
    The connection point of the file share.
    createdAt String
    The creation time of the file share in ISO 8601 format.
    creatorTaskId String
    The ID of the task that created the file share.
    id String
    The provider-assigned unique ID for this managed resource.
    networkName String
    The name of the network associated with the file share.
    shareNetworkName String
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    status String
    The status of the file share.
    subnetName String
    The name of the subnet associated with the file share

    Look up Existing FileShare Resource

    Get an existing FileShare 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?: FileShareState, opts?: CustomResourceOptions): FileShare
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            accesses: Optional[Sequence[FileShareAccessArgs]] = None,
            connection_point: Optional[str] = None,
            created_at: Optional[str] = None,
            creator_task_id: Optional[str] = None,
            file_share_id: Optional[str] = None,
            name: Optional[str] = None,
            network: Optional[FileShareNetworkArgs] = None,
            network_name: Optional[str] = None,
            project_id: Optional[float] = None,
            project_name: Optional[str] = None,
            protocol: Optional[str] = None,
            region_id: Optional[float] = None,
            region_name: Optional[str] = None,
            share_network_name: Optional[str] = None,
            size: Optional[float] = None,
            status: Optional[str] = None,
            subnet_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            type_name: Optional[str] = None) -> FileShare
    func GetFileShare(ctx *Context, name string, id IDInput, state *FileShareState, opts ...ResourceOption) (*FileShare, error)
    public static FileShare Get(string name, Input<string> id, FileShareState? state, CustomResourceOptions? opts = null)
    public static FileShare get(String name, Output<String> id, FileShareState state, CustomResourceOptions options)
    resources:  _:    type: gcore:FileShare    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:
    Accesses List<FileShareAccess>
    ConnectionPoint string
    The connection point of the file share.
    CreatedAt string
    The creation time of the file share in ISO 8601 format.
    CreatorTaskId string
    The ID of the task that created the file share.
    FileShareId string
    The ID of this resource.
    Name string
    The name of the file share. It must be unique within the project and region.
    Network FileShareNetwork
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    NetworkName string
    The name of the network associated with the file share.
    ProjectId double
    Project ID, only one of projectid or projectname should be set
    ProjectName string
    Project name, only one of projectid or projectname should be set
    Protocol string
    The protocol used by the file share. Currently, only 'NFS' is supported.
    RegionId double
    Region ID, only one of regionid or regionname should be set
    RegionName string
    Region name, only one of regionid or regionname should be set
    ShareNetworkName string
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    Size double
    The size of the file share in GB. It must be a positive integer.
    Status string
    The status of the file share.
    SubnetName string
    The name of the subnet associated with the file share
    Tags Dictionary<string, string>
    Tags to associate with the file share. Tags are key-value pairs.
    TypeName string
    The type of the file share. Must be one of 'standard' or 'vast'.
    Accesses []FileShareAccessArgs
    ConnectionPoint string
    The connection point of the file share.
    CreatedAt string
    The creation time of the file share in ISO 8601 format.
    CreatorTaskId string
    The ID of the task that created the file share.
    FileShareId string
    The ID of this resource.
    Name string
    The name of the file share. It must be unique within the project and region.
    Network FileShareNetworkArgs
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    NetworkName string
    The name of the network associated with the file share.
    ProjectId float64
    Project ID, only one of projectid or projectname should be set
    ProjectName string
    Project name, only one of projectid or projectname should be set
    Protocol string
    The protocol used by the file share. Currently, only 'NFS' is supported.
    RegionId float64
    Region ID, only one of regionid or regionname should be set
    RegionName string
    Region name, only one of regionid or regionname should be set
    ShareNetworkName string
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    Size float64
    The size of the file share in GB. It must be a positive integer.
    Status string
    The status of the file share.
    SubnetName string
    The name of the subnet associated with the file share
    Tags map[string]string
    Tags to associate with the file share. Tags are key-value pairs.
    TypeName string
    The type of the file share. Must be one of 'standard' or 'vast'.
    accesses List<FileShareAccess>
    connectionPoint String
    The connection point of the file share.
    createdAt String
    The creation time of the file share in ISO 8601 format.
    creatorTaskId String
    The ID of the task that created the file share.
    fileShareId String
    The ID of this resource.
    name String
    The name of the file share. It must be unique within the project and region.
    network FileShareNetwork
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    networkName String
    The name of the network associated with the file share.
    projectId Double
    Project ID, only one of projectid or projectname should be set
    projectName String
    Project name, only one of projectid or projectname should be set
    protocol String
    The protocol used by the file share. Currently, only 'NFS' is supported.
    regionId Double
    Region ID, only one of regionid or regionname should be set
    regionName String
    Region name, only one of regionid or regionname should be set
    shareNetworkName String
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    size Double
    The size of the file share in GB. It must be a positive integer.
    status String
    The status of the file share.
    subnetName String
    The name of the subnet associated with the file share
    tags Map<String,String>
    Tags to associate with the file share. Tags are key-value pairs.
    typeName String
    The type of the file share. Must be one of 'standard' or 'vast'.
    accesses FileShareAccess[]
    connectionPoint string
    The connection point of the file share.
    createdAt string
    The creation time of the file share in ISO 8601 format.
    creatorTaskId string
    The ID of the task that created the file share.
    fileShareId string
    The ID of this resource.
    name string
    The name of the file share. It must be unique within the project and region.
    network FileShareNetwork
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    networkName string
    The name of the network associated with the file share.
    projectId number
    Project ID, only one of projectid or projectname should be set
    projectName string
    Project name, only one of projectid or projectname should be set
    protocol string
    The protocol used by the file share. Currently, only 'NFS' is supported.
    regionId number
    Region ID, only one of regionid or regionname should be set
    regionName string
    Region name, only one of regionid or regionname should be set
    shareNetworkName string
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    size number
    The size of the file share in GB. It must be a positive integer.
    status string
    The status of the file share.
    subnetName string
    The name of the subnet associated with the file share
    tags {[key: string]: string}
    Tags to associate with the file share. Tags are key-value pairs.
    typeName string
    The type of the file share. Must be one of 'standard' or 'vast'.
    accesses Sequence[FileShareAccessArgs]
    connection_point str
    The connection point of the file share.
    created_at str
    The creation time of the file share in ISO 8601 format.
    creator_task_id str
    The ID of the task that created the file share.
    file_share_id str
    The ID of this resource.
    name str
    The name of the file share. It must be unique within the project and region.
    network FileShareNetworkArgs
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    network_name str
    The name of the network associated with the file share.
    project_id float
    Project ID, only one of projectid or projectname should be set
    project_name str
    Project name, only one of projectid or projectname should be set
    protocol str
    The protocol used by the file share. Currently, only 'NFS' is supported.
    region_id float
    Region ID, only one of regionid or regionname should be set
    region_name str
    Region name, only one of regionid or regionname should be set
    share_network_name str
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    size float
    The size of the file share in GB. It must be a positive integer.
    status str
    The status of the file share.
    subnet_name str
    The name of the subnet associated with the file share
    tags Mapping[str, str]
    Tags to associate with the file share. Tags are key-value pairs.
    type_name str
    The type of the file share. Must be one of 'standard' or 'vast'.
    accesses List<Property Map>
    connectionPoint String
    The connection point of the file share.
    createdAt String
    The creation time of the file share in ISO 8601 format.
    creatorTaskId String
    The ID of the task that created the file share.
    fileShareId String
    The ID of this resource.
    name String
    The name of the file share. It must be unique within the project and region.
    network Property Map
    Network configuration for the file share. It must include a network ID and optionally a subnet ID. (Only required for type_name: 'standard')
    networkName String
    The name of the network associated with the file share.
    projectId Number
    Project ID, only one of projectid or projectname should be set
    projectName String
    Project name, only one of projectid or projectname should be set
    protocol String
    The protocol used by the file share. Currently, only 'NFS' is supported.
    regionId Number
    Region ID, only one of regionid or regionname should be set
    regionName String
    Region name, only one of regionid or regionname should be set
    shareNetworkName String
    The name of the share network associated with the file share. This is only applicable for 'standard'.
    size Number
    The size of the file share in GB. It must be a positive integer.
    status String
    The status of the file share.
    subnetName String
    The name of the subnet associated with the file share
    tags Map<String>
    Tags to associate with the file share. Tags are key-value pairs.
    typeName String
    The type of the file share. Must be one of 'standard' or 'vast'.

    Supporting Types

    FileShareAccess, FileShareAccessArgs

    AccessMode string
    The access mode of the file share (ro/rw).
    IpAddress string
    The IP address of the file share.
    AccessMode string
    The access mode of the file share (ro/rw).
    IpAddress string
    The IP address of the file share.
    accessMode String
    The access mode of the file share (ro/rw).
    ipAddress String
    The IP address of the file share.
    accessMode string
    The access mode of the file share (ro/rw).
    ipAddress string
    The IP address of the file share.
    access_mode str
    The access mode of the file share (ro/rw).
    ip_address str
    The IP address of the file share.
    accessMode String
    The access mode of the file share (ro/rw).
    ipAddress String
    The IP address of the file share.

    FileShareNetwork, FileShareNetworkArgs

    NetworkId string
    The ID of the network to which the file share will be connected. This is required for 'standard'.
    SubnetId string
    The ID of the subnet within the network. This is optional and can be used to specify a particular subnet for the file share.
    NetworkId string
    The ID of the network to which the file share will be connected. This is required for 'standard'.
    SubnetId string
    The ID of the subnet within the network. This is optional and can be used to specify a particular subnet for the file share.
    networkId String
    The ID of the network to which the file share will be connected. This is required for 'standard'.
    subnetId String
    The ID of the subnet within the network. This is optional and can be used to specify a particular subnet for the file share.
    networkId string
    The ID of the network to which the file share will be connected. This is required for 'standard'.
    subnetId string
    The ID of the subnet within the network. This is optional and can be used to specify a particular subnet for the file share.
    network_id str
    The ID of the network to which the file share will be connected. This is required for 'standard'.
    subnet_id str
    The ID of the subnet within the network. This is optional and can be used to specify a particular subnet for the file share.
    networkId String
    The ID of the network to which the file share will be connected. This is required for 'standard'.
    subnetId String
    The ID of the subnet within the network. This is optional and can be used to specify a particular subnet for the file share.

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    gcore 0.29.1 published on Wednesday, Sep 10, 2025 by g-core