1. Packages
  2. Gcore Provider
  3. API Docs
  4. CloudFileShare
Viewing docs for gcore 2.0.0-alpha.3
published on Monday, Mar 30, 2026 by g-core
Schema (JSON)
g-core/terraform-provider-gcore

gcore.CloudFileShare

Viewing docs for gcore 2.0.0-alpha.3
published on Monday, Mar 30, 2026 by g-core
Schema (JSON)
g-core/terraform-provider-gcore

    File shares provide NFS-based shared storage that can be mounted by virtual machines and Kubernetes clusters for persistent data.

    Example Usage

    Standard NFS file share

    Create a standard NFS file share attached to an existing network.

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

const fileShareStandard = new gcore.CloudFileShare("file_share_standard", {
    projectId: 1,
    regionId: 1,
    name: "tf-file-share-standard",
    size: 20,
    typeName: "standard",
    protocol: "NFS",
    network: {
        networkId: "378ba73d-16c5-4a4e-a755-d9406dd73e63",
    },
});

    import pulumi
import pulumi_gcore as gcore

file_share_standard = gcore.CloudFileShare("file_share_standard",
    project_id=1,
    region_id=1,
    name="tf-file-share-standard",
    size=20,
    type_name="standard",
    protocol="NFS",
    network={
        "network_id": "378ba73d-16c5-4a4e-a755-d9406dd73e63",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gcore.NewCloudFileShare(ctx, "file_share_standard", &gcore.CloudFileShareArgs{
			ProjectId: pulumi.Float64(1),
			RegionId:  pulumi.Float64(1),
			Name:      pulumi.String("tf-file-share-standard"),
			Size:      pulumi.Float64(20),
			TypeName:  pulumi.String("standard"),
			Protocol:  pulumi.String("NFS"),
			Network: &gcore.CloudFileShareNetworkArgs{
				NetworkId: pulumi.String("378ba73d-16c5-4a4e-a755-d9406dd73e63"),
			},
		})
		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 fileShareStandard = new Gcore.CloudFileShare("file_share_standard", new()
    {
        ProjectId = 1,
        RegionId = 1,
        Name = "tf-file-share-standard",
        Size = 20,
        TypeName = "standard",
        Protocol = "NFS",
        Network = new Gcore.Inputs.CloudFileShareNetworkArgs
        {
            NetworkId = "378ba73d-16c5-4a4e-a755-d9406dd73e63",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.CloudFileShare;
import com.pulumi.gcore.CloudFileShareArgs;
import com.pulumi.gcore.inputs.CloudFileShareNetworkArgs;
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) {
        var fileShareStandard = new CloudFileShare("fileShareStandard", CloudFileShareArgs.builder()
            .projectId(1.0)
            .regionId(1.0)
            .name("tf-file-share-standard")
            .size(20.0)
            .typeName("standard")
            .protocol("NFS")
            .network(CloudFileShareNetworkArgs.builder()
                .networkId("378ba73d-16c5-4a4e-a755-d9406dd73e63")
                .build())
            .build());

    }
}

    resources:
  fileShareStandard:
    type: gcore:CloudFileShare
    name: file_share_standard
    properties:
      projectId: 1
      regionId: 1
      name: tf-file-share-standard
      size: 20
      typeName: standard
      protocol: NFS
      network:
        networkId: 378ba73d-16c5-4a4e-a755-d9406dd73e63

    VAST NFS file share

    Create a VAST-backed NFS file share with custom share settings.

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

const fileShareVast = new gcore.CloudFileShare("file_share_vast", {
    projectId: 1,
    regionId: 1,
    name: "tf-file-share-vast",
    size: 10,
    typeName: "vast",
    protocol: "NFS",
    shareSettings: {
        allowedCharacters: "LCD",
        pathLength: "LCD",
        rootSquash: true,
    },
});

    import pulumi
import pulumi_gcore as gcore

file_share_vast = gcore.CloudFileShare("file_share_vast",
    project_id=1,
    region_id=1,
    name="tf-file-share-vast",
    size=10,
    type_name="vast",
    protocol="NFS",
    share_settings={
        "allowed_characters": "LCD",
        "path_length": "LCD",
        "root_squash": True,
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gcore.NewCloudFileShare(ctx, "file_share_vast", &gcore.CloudFileShareArgs{
			ProjectId: pulumi.Float64(1),
			RegionId:  pulumi.Float64(1),
			Name:      pulumi.String("tf-file-share-vast"),
			Size:      pulumi.Float64(10),
			TypeName:  pulumi.String("vast"),
			Protocol:  pulumi.String("NFS"),
			ShareSettings: &gcore.CloudFileShareShareSettingsArgs{
				AllowedCharacters: pulumi.String("LCD"),
				PathLength:        pulumi.String("LCD"),
				RootSquash:        pulumi.Bool(true),
			},
		})
		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 fileShareVast = new Gcore.CloudFileShare("file_share_vast", new()
    {
        ProjectId = 1,
        RegionId = 1,
        Name = "tf-file-share-vast",
        Size = 10,
        TypeName = "vast",
        Protocol = "NFS",
        ShareSettings = new Gcore.Inputs.CloudFileShareShareSettingsArgs
        {
            AllowedCharacters = "LCD",
            PathLength = "LCD",
            RootSquash = true,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.CloudFileShare;
import com.pulumi.gcore.CloudFileShareArgs;
import com.pulumi.gcore.inputs.CloudFileShareShareSettingsArgs;
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) {
        var fileShareVast = new CloudFileShare("fileShareVast", CloudFileShareArgs.builder()
            .projectId(1.0)
            .regionId(1.0)
            .name("tf-file-share-vast")
            .size(10.0)
            .typeName("vast")
            .protocol("NFS")
            .shareSettings(CloudFileShareShareSettingsArgs.builder()
                .allowedCharacters("LCD")
                .pathLength("LCD")
                .rootSquash(true)
                .build())
            .build());

    }
}

    resources:
  fileShareVast:
    type: gcore:CloudFileShare
    name: file_share_vast
    properties:
      projectId: 1
      regionId: 1
      name: tf-file-share-vast
      size: 10
      typeName: vast
      protocol: NFS
      shareSettings:
        allowedCharacters: LCD
        pathLength: LCD
        rootSquash: true

    Create CloudFileShare Resource

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

    Constructor syntax

    new CloudFileShare(name: string, args: CloudFileShareArgs, opts?: CustomResourceOptions);
    @overload
def CloudFileShare(resource_name: str,
                   args: CloudFileShareArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def CloudFileShare(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   protocol: Optional[str] = None,
                   size: Optional[float] = None,
                   name: Optional[str] = None,
                   network: Optional[CloudFileShareNetworkArgs] = None,
                   project_id: Optional[float] = None,
                   region_id: Optional[float] = None,
                   share_settings: Optional[CloudFileShareShareSettingsArgs] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   type_name: Optional[str] = None)
    func NewCloudFileShare(ctx *Context, name string, args CloudFileShareArgs, opts ...ResourceOption) (*CloudFileShare, error)
    public CloudFileShare(string name, CloudFileShareArgs args, CustomResourceOptions? opts = null)
    public CloudFileShare(String name, CloudFileShareArgs args)
public CloudFileShare(String name, CloudFileShareArgs args, CustomResourceOptions options)

    type: gcore:CloudFileShare
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 CloudFileShareArgs
    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 CloudFileShareArgs
    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 CloudFileShareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudFileShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudFileShareArgs
    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 cloudFileShareResource = new Gcore.Index.CloudFileShare("cloudFileShareResource", new()
{
    Protocol = "string",
    Size = 0,
    Name = "string",
    Network = new Gcore.Inputs.CloudFileShareNetworkArgs
    {
        NetworkId = "string",
        SubnetId = "string",
    },
    ProjectId = 0,
    RegionId = 0,
    ShareSettings = new Gcore.Inputs.CloudFileShareShareSettingsArgs
    {
        AllowedCharacters = "string",
        PathLength = "string",
        RootSquash = false,
    },
    Tags = 
    {
        { "string", "string" },
    },
    TypeName = "string",
});

    example, err := gcore.NewCloudFileShare(ctx, "cloudFileShareResource", &gcore.CloudFileShareArgs{
	Protocol: pulumi.String("string"),
	Size:     pulumi.Float64(0),
	Name:     pulumi.String("string"),
	Network: &gcore.CloudFileShareNetworkArgs{
		NetworkId: pulumi.String("string"),
		SubnetId:  pulumi.String("string"),
	},
	ProjectId: pulumi.Float64(0),
	RegionId:  pulumi.Float64(0),
	ShareSettings: &gcore.CloudFileShareShareSettingsArgs{
		AllowedCharacters: pulumi.String("string"),
		PathLength:        pulumi.String("string"),
		RootSquash:        pulumi.Bool(false),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TypeName: pulumi.String("string"),
})

    var cloudFileShareResource = new CloudFileShare("cloudFileShareResource", CloudFileShareArgs.builder()
    .protocol("string")
    .size(0.0)
    .name("string")
    .network(CloudFileShareNetworkArgs.builder()
        .networkId("string")
        .subnetId("string")
        .build())
    .projectId(0.0)
    .regionId(0.0)
    .shareSettings(CloudFileShareShareSettingsArgs.builder()
        .allowedCharacters("string")
        .pathLength("string")
        .rootSquash(false)
        .build())
    .tags(Map.of("string", "string"))
    .typeName("string")
    .build());

    cloud_file_share_resource = gcore.CloudFileShare("cloudFileShareResource",
    protocol="string",
    size=0,
    name="string",
    network={
        "network_id": "string",
        "subnet_id": "string",
    },
    project_id=0,
    region_id=0,
    share_settings={
        "allowed_characters": "string",
        "path_length": "string",
        "root_squash": False,
    },
    tags={
        "string": "string",
    },
    type_name="string")

    const cloudFileShareResource = new gcore.CloudFileShare("cloudFileShareResource", {
    protocol: "string",
    size: 0,
    name: "string",
    network: {
        networkId: "string",
        subnetId: "string",
    },
    projectId: 0,
    regionId: 0,
    shareSettings: {
        allowedCharacters: "string",
        pathLength: "string",
        rootSquash: false,
    },
    tags: {
        string: "string",
    },
    typeName: "string",
});

    type: gcore:CloudFileShare
properties:
    name: string
    network:
        networkId: string
        subnetId: string
    projectId: 0
    protocol: string
    regionId: 0
    shareSettings:
        allowedCharacters: string
        pathLength: string
        rootSquash: false
    size: 0
    tags:
        string: string
    typeName: string

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

    Protocol string
    File share protocol Available values: "NFS".
    Size double
    File share size in GiB
    Name string
    File share name
    Network CloudFileShareNetwork
    File share network configuration
    ProjectId double
    Project ID
    RegionId double
    Region ID
    ShareSettings CloudFileShareShareSettings
    Configuration settings for the share
    Tags Dictionary<string, string>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TypeName string
    Standard file share type Available values: "standard", "vast".
    Protocol string
    File share protocol Available values: "NFS".
    Size float64
    File share size in GiB
    Name string
    File share name
    Network CloudFileShareNetworkArgs
    File share network configuration
    ProjectId float64
    Project ID
    RegionId float64
    Region ID
    ShareSettings CloudFileShareShareSettingsArgs
    Configuration settings for the share
    Tags map[string]string
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TypeName string
    Standard file share type Available values: "standard", "vast".
    protocol String
    File share protocol Available values: "NFS".
    size Double
    File share size in GiB
    name String
    File share name
    network CloudFileShareNetwork
    File share network configuration
    projectId Double
    Project ID
    regionId Double
    Region ID
    shareSettings CloudFileShareShareSettings
    Configuration settings for the share
    tags Map<String,String>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName String
    Standard file share type Available values: "standard", "vast".
    protocol string
    File share protocol Available values: "NFS".
    size number
    File share size in GiB
    name string
    File share name
    network CloudFileShareNetwork
    File share network configuration
    projectId number
    Project ID
    regionId number
    Region ID
    shareSettings CloudFileShareShareSettings
    Configuration settings for the share
    tags {[key: string]: string}
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName string
    Standard file share type Available values: "standard", "vast".
    protocol str
    File share protocol Available values: "NFS".
    size float
    File share size in GiB
    name str
    File share name
    network CloudFileShareNetworkArgs
    File share network configuration
    project_id float
    Project ID
    region_id float
    Region ID
    share_settings CloudFileShareShareSettingsArgs
    Configuration settings for the share
    tags Mapping[str, str]
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    type_name str
    Standard file share type Available values: "standard", "vast".
    protocol String
    File share protocol Available values: "NFS".
    size Number
    File share size in GiB
    name String
    File share name
    network Property Map
    File share network configuration
    projectId Number
    Project ID
    regionId Number
    Region ID
    shareSettings Property Map
    Configuration settings for the share
    tags Map<String>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName String
    Standard file share type Available values: "standard", "vast".

    Outputs

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

    AccessRuleIds List<string>
    List of access rules IDs associated with the file share
    ConnectionPoint string
    Connection point. Can be null during File share creation
    CreatedAt string
    Datetime when the file share was created
    CreatorTaskId string
    Task that created this entity
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkId string
    Network ID.
    NetworkName string
    Network name.
    Region string
    Region name
    ShareNetworkName string
    Share network name. May be null if the file share was created with volume type VAST
    Status string
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    SubnetId string
    Subnet ID.
    SubnetName string
    Subnet name.
    AccessRuleIds []string
    List of access rules IDs associated with the file share
    ConnectionPoint string
    Connection point. Can be null during File share creation
    CreatedAt string
    Datetime when the file share was created
    CreatorTaskId string
    Task that created this entity
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkId string
    Network ID.
    NetworkName string
    Network name.
    Region string
    Region name
    ShareNetworkName string
    Share network name. May be null if the file share was created with volume type VAST
    Status string
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    SubnetId string
    Subnet ID.
    SubnetName string
    Subnet name.
    accessRuleIds List<String>
    List of access rules IDs associated with the file share
    connectionPoint String
    Connection point. Can be null during File share creation
    createdAt String
    Datetime when the file share was created
    creatorTaskId String
    Task that created this entity
    id String
    The provider-assigned unique ID for this managed resource.
    networkId String
    Network ID.
    networkName String
    Network name.
    region String
    Region name
    shareNetworkName String
    Share network name. May be null if the file share was created with volume type VAST
    status String
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    subnetId String
    Subnet ID.
    subnetName String
    Subnet name.
    accessRuleIds string[]
    List of access rules IDs associated with the file share
    connectionPoint string
    Connection point. Can be null during File share creation
    createdAt string
    Datetime when the file share was created
    creatorTaskId string
    Task that created this entity
    id string
    The provider-assigned unique ID for this managed resource.
    networkId string
    Network ID.
    networkName string
    Network name.
    region string
    Region name
    shareNetworkName string
    Share network name. May be null if the file share was created with volume type VAST
    status string
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    subnetId string
    Subnet ID.
    subnetName string
    Subnet name.
    access_rule_ids Sequence[str]
    List of access rules IDs associated with the file share
    connection_point str
    Connection point. Can be null during File share creation
    created_at str
    Datetime when the file share was created
    creator_task_id str
    Task that created this entity
    id str
    The provider-assigned unique ID for this managed resource.
    network_id str
    Network ID.
    network_name str
    Network name.
    region str
    Region name
    share_network_name str
    Share network name. May be null if the file share was created with volume type VAST
    status str
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    subnet_id str
    Subnet ID.
    subnet_name str
    Subnet name.
    accessRuleIds List<String>
    List of access rules IDs associated with the file share
    connectionPoint String
    Connection point. Can be null during File share creation
    createdAt String
    Datetime when the file share was created
    creatorTaskId String
    Task that created this entity
    id String
    The provider-assigned unique ID for this managed resource.
    networkId String
    Network ID.
    networkName String
    Network name.
    region String
    Region name
    shareNetworkName String
    Share network name. May be null if the file share was created with volume type VAST
    status String
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    subnetId String
    Subnet ID.
    subnetName String
    Subnet name.

    Look up Existing CloudFileShare Resource

    Get an existing CloudFileShare 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?: CloudFileShareState, opts?: CustomResourceOptions): CloudFileShare
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_rule_ids: Optional[Sequence[str]] = None,
        connection_point: Optional[str] = None,
        created_at: Optional[str] = None,
        creator_task_id: Optional[str] = None,
        name: Optional[str] = None,
        network: Optional[CloudFileShareNetworkArgs] = None,
        network_id: Optional[str] = None,
        network_name: Optional[str] = None,
        project_id: Optional[float] = None,
        protocol: Optional[str] = None,
        region: Optional[str] = None,
        region_id: Optional[float] = None,
        share_network_name: Optional[str] = None,
        share_settings: Optional[CloudFileShareShareSettingsArgs] = None,
        size: Optional[float] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        subnet_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        type_name: Optional[str] = None) -> CloudFileShare
    func GetCloudFileShare(ctx *Context, name string, id IDInput, state *CloudFileShareState, opts ...ResourceOption) (*CloudFileShare, error)
    public static CloudFileShare Get(string name, Input<string> id, CloudFileShareState? state, CustomResourceOptions? opts = null)
    public static CloudFileShare get(String name, Output<String> id, CloudFileShareState state, CustomResourceOptions options)
    resources:  _:    type: gcore:CloudFileShare    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:
    AccessRuleIds List<string>
    List of access rules IDs associated with the file share
    ConnectionPoint string
    Connection point. Can be null during File share creation
    CreatedAt string
    Datetime when the file share was created
    CreatorTaskId string
    Task that created this entity
    Name string
    File share name
    Network CloudFileShareNetwork
    File share network configuration
    NetworkId string
    Network ID.
    NetworkName string
    Network name.
    ProjectId double
    Project ID
    Protocol string
    File share protocol Available values: "NFS".
    Region string
    Region name
    RegionId double
    Region ID
    ShareNetworkName string
    Share network name. May be null if the file share was created with volume type VAST
    ShareSettings CloudFileShareShareSettings
    Configuration settings for the share
    Size double
    File share size in GiB
    Status string
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    SubnetId string
    Subnet ID.
    SubnetName string
    Subnet name.
    Tags Dictionary<string, string>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TypeName string
    Standard file share type Available values: "standard", "vast".
    AccessRuleIds []string
    List of access rules IDs associated with the file share
    ConnectionPoint string
    Connection point. Can be null during File share creation
    CreatedAt string
    Datetime when the file share was created
    CreatorTaskId string
    Task that created this entity
    Name string
    File share name
    Network CloudFileShareNetworkArgs
    File share network configuration
    NetworkId string
    Network ID.
    NetworkName string
    Network name.
    ProjectId float64
    Project ID
    Protocol string
    File share protocol Available values: "NFS".
    Region string
    Region name
    RegionId float64
    Region ID
    ShareNetworkName string
    Share network name. May be null if the file share was created with volume type VAST
    ShareSettings CloudFileShareShareSettingsArgs
    Configuration settings for the share
    Size float64
    File share size in GiB
    Status string
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    SubnetId string
    Subnet ID.
    SubnetName string
    Subnet name.
    Tags map[string]string
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TypeName string
    Standard file share type Available values: "standard", "vast".
    accessRuleIds List<String>
    List of access rules IDs associated with the file share
    connectionPoint String
    Connection point. Can be null during File share creation
    createdAt String
    Datetime when the file share was created
    creatorTaskId String
    Task that created this entity
    name String
    File share name
    network CloudFileShareNetwork
    File share network configuration
    networkId String
    Network ID.
    networkName String
    Network name.
    projectId Double
    Project ID
    protocol String
    File share protocol Available values: "NFS".
    region String
    Region name
    regionId Double
    Region ID
    shareNetworkName String
    Share network name. May be null if the file share was created with volume type VAST
    shareSettings CloudFileShareShareSettings
    Configuration settings for the share
    size Double
    File share size in GiB
    status String
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    subnetId String
    Subnet ID.
    subnetName String
    Subnet name.
    tags Map<String,String>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName String
    Standard file share type Available values: "standard", "vast".
    accessRuleIds string[]
    List of access rules IDs associated with the file share
    connectionPoint string
    Connection point. Can be null during File share creation
    createdAt string
    Datetime when the file share was created
    creatorTaskId string
    Task that created this entity
    name string
    File share name
    network CloudFileShareNetwork
    File share network configuration
    networkId string
    Network ID.
    networkName string
    Network name.
    projectId number
    Project ID
    protocol string
    File share protocol Available values: "NFS".
    region string
    Region name
    regionId number
    Region ID
    shareNetworkName string
    Share network name. May be null if the file share was created with volume type VAST
    shareSettings CloudFileShareShareSettings
    Configuration settings for the share
    size number
    File share size in GiB
    status string
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    subnetId string
    Subnet ID.
    subnetName string
    Subnet name.
    tags {[key: string]: string}
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName string
    Standard file share type Available values: "standard", "vast".
    access_rule_ids Sequence[str]
    List of access rules IDs associated with the file share
    connection_point str
    Connection point. Can be null during File share creation
    created_at str
    Datetime when the file share was created
    creator_task_id str
    Task that created this entity
    name str
    File share name
    network CloudFileShareNetworkArgs
    File share network configuration
    network_id str
    Network ID.
    network_name str
    Network name.
    project_id float
    Project ID
    protocol str
    File share protocol Available values: "NFS".
    region str
    Region name
    region_id float
    Region ID
    share_network_name str
    Share network name. May be null if the file share was created with volume type VAST
    share_settings CloudFileShareShareSettingsArgs
    Configuration settings for the share
    size float
    File share size in GiB
    status str
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    subnet_id str
    Subnet ID.
    subnet_name str
    Subnet name.
    tags Mapping[str, str]
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    type_name str
    Standard file share type Available values: "standard", "vast".
    accessRuleIds List<String>
    List of access rules IDs associated with the file share
    connectionPoint String
    Connection point. Can be null during File share creation
    createdAt String
    Datetime when the file share was created
    creatorTaskId String
    Task that created this entity
    name String
    File share name
    network Property Map
    File share network configuration
    networkId String
    Network ID.
    networkName String
    Network name.
    projectId Number
    Project ID
    protocol String
    File share protocol Available values: "NFS".
    region String
    Region name
    regionId Number
    Region ID
    shareNetworkName String
    Share network name. May be null if the file share was created with volume type VAST
    shareSettings Property Map
    Configuration settings for the share
    size Number
    File share size in GiB
    status String
    File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
    subnetId String
    Subnet ID.
    subnetName String
    Subnet name.
    tags Map<String>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName String
    Standard file share type Available values: "standard", "vast".

    Supporting Types

    CloudFileShareNetwork, CloudFileShareNetworkArgs

    NetworkId string
    Network ID.
    SubnetId string
    Subnetwork ID. If the subnet is not selected, it will be selected automatically.
    NetworkId string
    Network ID.
    SubnetId string
    Subnetwork ID. If the subnet is not selected, it will be selected automatically.
    networkId String
    Network ID.
    subnetId String
    Subnetwork ID. If the subnet is not selected, it will be selected automatically.
    networkId string
    Network ID.
    subnetId string
    Subnetwork ID. If the subnet is not selected, it will be selected automatically.
    network_id str
    Network ID.
    subnet_id str
    Subnetwork ID. If the subnet is not selected, it will be selected automatically.
    networkId String
    Network ID.
    subnetId String
    Subnetwork ID. If the subnet is not selected, it will be selected automatically.

    CloudFileShareShareSettings, CloudFileShareShareSettingsArgs

    AllowedCharacters string
    Determines which characters are allowed in file names. Choose between:

    • Lowest Common Denominator (LCD), allows only characters allowed by all VAST Cluster-supported protocols
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    PathLength string
    Affects the maximum limit of file path component name length. Choose between:

    • Lowest Common Denominator (LCD), imposes the lowest common denominator file length limit of all VAST Cluster-supported protocols. With this (default) option, the limitation on the length of a single component of the path is 255 characters
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    RootSquash bool
    Enables or disables root squash for NFS clients.

    • If true (default), root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
    • If false, root squash is disabled: the NFS client root user retains root privileges. Use this option if you trust the root user not to perform operations that will corrupt data.
    AllowedCharacters string
    Determines which characters are allowed in file names. Choose between:

    • Lowest Common Denominator (LCD), allows only characters allowed by all VAST Cluster-supported protocols
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    PathLength string
    Affects the maximum limit of file path component name length. Choose between:

    • Lowest Common Denominator (LCD), imposes the lowest common denominator file length limit of all VAST Cluster-supported protocols. With this (default) option, the limitation on the length of a single component of the path is 255 characters
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    RootSquash bool
    Enables or disables root squash for NFS clients.

    • If true (default), root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
    • If false, root squash is disabled: the NFS client root user retains root privileges. Use this option if you trust the root user not to perform operations that will corrupt data.
    allowedCharacters String
    Determines which characters are allowed in file names. Choose between:

    • Lowest Common Denominator (LCD), allows only characters allowed by all VAST Cluster-supported protocols
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    pathLength String
    Affects the maximum limit of file path component name length. Choose between:

    • Lowest Common Denominator (LCD), imposes the lowest common denominator file length limit of all VAST Cluster-supported protocols. With this (default) option, the limitation on the length of a single component of the path is 255 characters
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    rootSquash Boolean
    Enables or disables root squash for NFS clients.

    • If true (default), root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
    • If false, root squash is disabled: the NFS client root user retains root privileges. Use this option if you trust the root user not to perform operations that will corrupt data.
    allowedCharacters string
    Determines which characters are allowed in file names. Choose between:

    • Lowest Common Denominator (LCD), allows only characters allowed by all VAST Cluster-supported protocols
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    pathLength string
    Affects the maximum limit of file path component name length. Choose between:

    • Lowest Common Denominator (LCD), imposes the lowest common denominator file length limit of all VAST Cluster-supported protocols. With this (default) option, the limitation on the length of a single component of the path is 255 characters
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    rootSquash boolean
    Enables or disables root squash for NFS clients.

    • If true (default), root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
    • If false, root squash is disabled: the NFS client root user retains root privileges. Use this option if you trust the root user not to perform operations that will corrupt data.
    allowed_characters str
    Determines which characters are allowed in file names. Choose between:

    • Lowest Common Denominator (LCD), allows only characters allowed by all VAST Cluster-supported protocols
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    path_length str
    Affects the maximum limit of file path component name length. Choose between:

    • Lowest Common Denominator (LCD), imposes the lowest common denominator file length limit of all VAST Cluster-supported protocols. With this (default) option, the limitation on the length of a single component of the path is 255 characters
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    root_squash bool
    Enables or disables root squash for NFS clients.

    • If true (default), root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
    • If false, root squash is disabled: the NFS client root user retains root privileges. Use this option if you trust the root user not to perform operations that will corrupt data.
    allowedCharacters String
    Determines which characters are allowed in file names. Choose between:

    • Lowest Common Denominator (LCD), allows only characters allowed by all VAST Cluster-supported protocols
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    pathLength String
    Affects the maximum limit of file path component name length. Choose between:

    • Lowest Common Denominator (LCD), imposes the lowest common denominator file length limit of all VAST Cluster-supported protocols. With this (default) option, the limitation on the length of a single component of the path is 255 characters
    • Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. Available values: "LCD", "NPL".
    rootSquash Boolean
    Enables or disables root squash for NFS clients.

    • If true (default), root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
    • If false, root squash is disabled: the NFS client root user retains root privileges. Use this option if you trust the root user not to perform operations that will corrupt data.

    Import

    $ pulumi import gcore:index/cloudFileShare:CloudFileShare example '<project_id>/<region_id>/<file_share_id>'

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

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    Viewing docs for gcore 2.0.0-alpha.3
    published on Monday, Mar 30, 2026 by g-core
    Schema (JSON)
    g-core/terraform-provider-gcore
      Try Pulumi Cloud free. Your team will thank you.