1. Packages
  2. Gcore Provider
  3. API Docs
  4. getCloudFileShare
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.getCloudFileShare

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

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

const exampleCloudFileShare = gcore.getCloudFileShare({
    projectId: 1,
    regionId: 1,
    fileShareId: "bd8c47ee-e565-4e26-8840-b537e6827b08",
});

    import pulumi
import pulumi_gcore as gcore

example_cloud_file_share = gcore.get_cloud_file_share(project_id=1,
    region_id=1,
    file_share_id="bd8c47ee-e565-4e26-8840-b537e6827b08")

    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.LookupCloudFileShare(ctx, &gcore.LookupCloudFileShareArgs{
			ProjectId:   pulumi.Float64Ref(1),
			RegionId:    pulumi.Float64Ref(1),
			FileShareId: pulumi.StringRef("bd8c47ee-e565-4e26-8840-b537e6827b08"),
		}, nil)
		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 exampleCloudFileShare = Gcore.GetCloudFileShare.Invoke(new()
    {
        ProjectId = 1,
        RegionId = 1,
        FileShareId = "bd8c47ee-e565-4e26-8840-b537e6827b08",
    });

});

    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.GetCloudFileShareArgs;
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 exampleCloudFileShare = GcoreFunctions.getCloudFileShare(GetCloudFileShareArgs.builder()
            .projectId(1)
            .regionId(1)
            .fileShareId("bd8c47ee-e565-4e26-8840-b537e6827b08")
            .build());

    }
}

    variables:
  exampleCloudFileShare:
    fn::invoke:
      function: gcore:getCloudFileShare
      arguments:
        projectId: 1
        regionId: 1
        fileShareId: bd8c47ee-e565-4e26-8840-b537e6827b08

    Using getCloudFileShare

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCloudFileShare(args: GetCloudFileShareArgs, opts?: InvokeOptions): Promise<GetCloudFileShareResult>
function getCloudFileShareOutput(args: GetCloudFileShareOutputArgs, opts?: InvokeOptions): Output<GetCloudFileShareResult>
    def get_cloud_file_share(file_share_id: Optional[str] = None,
                         find_one_by: Optional[GetCloudFileShareFindOneBy] = None,
                         project_id: Optional[float] = None,
                         region_id: Optional[float] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCloudFileShareResult
def get_cloud_file_share_output(file_share_id: Optional[pulumi.Input[str]] = None,
                         find_one_by: Optional[pulumi.Input[GetCloudFileShareFindOneByArgs]] = None,
                         project_id: Optional[pulumi.Input[float]] = None,
                         region_id: Optional[pulumi.Input[float]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCloudFileShareResult]
    func LookupCloudFileShare(ctx *Context, args *LookupCloudFileShareArgs, opts ...InvokeOption) (*LookupCloudFileShareResult, error)
func LookupCloudFileShareOutput(ctx *Context, args *LookupCloudFileShareOutputArgs, opts ...InvokeOption) LookupCloudFileShareResultOutput

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

    public static class GetCloudFileShare 
{
    public static Task<GetCloudFileShareResult> InvokeAsync(GetCloudFileShareArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudFileShareResult> Invoke(GetCloudFileShareInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudFileShareResult> getCloudFileShare(GetCloudFileShareArgs args, InvokeOptions options)
public static Output<GetCloudFileShareResult> getCloudFileShare(GetCloudFileShareArgs args, InvokeOptions options)

    fn::invoke:
  function: gcore:index/getCloudFileShare:getCloudFileShare
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getCloudFileShare Result

    The following output properties are available:

    Supporting Types

    GetCloudFileShareFindOneBy

    Name string
    File share name. Uses partial match.
    TypeName string
    File share type name Available values: "standard", "vast".
    Name string
    File share name. Uses partial match.
    TypeName string
    File share type name Available values: "standard", "vast".
    name String
    File share name. Uses partial match.
    typeName String
    File share type name Available values: "standard", "vast".
    name string
    File share name. Uses partial match.
    typeName string
    File share type name Available values: "standard", "vast".
    name str
    File share name. Uses partial match.
    type_name str
    File share type name Available values: "standard", "vast".
    name String
    File share name. Uses partial match.
    typeName String
    File share type name Available values: "standard", "vast".

    GetCloudFileShareShareSettings

    AllowedCharacters string
    Available values: "LCD", "NPL".
    PathLength string
    Available values: "LCD", "NPL".
    RootSquash bool
    Enables or disables root squash for NFS clients.

    • If true, 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.
    TypeName string
    Standard file share type Available values: "standard", "vast".
    AllowedCharacters string
    Available values: "LCD", "NPL".
    PathLength string
    Available values: "LCD", "NPL".
    RootSquash bool
    Enables or disables root squash for NFS clients.

    • If true, 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.
    TypeName string
    Standard file share type Available values: "standard", "vast".
    allowedCharacters String
    Available values: "LCD", "NPL".
    pathLength String
    Available values: "LCD", "NPL".
    rootSquash Boolean
    Enables or disables root squash for NFS clients.

    • If true, 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.
    typeName String
    Standard file share type Available values: "standard", "vast".
    allowedCharacters string
    Available values: "LCD", "NPL".
    pathLength string
    Available values: "LCD", "NPL".
    rootSquash boolean
    Enables or disables root squash for NFS clients.

    • If true, 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.
    typeName string
    Standard file share type Available values: "standard", "vast".
    allowed_characters str
    Available values: "LCD", "NPL".
    path_length str
    Available values: "LCD", "NPL".
    root_squash bool
    Enables or disables root squash for NFS clients.

    • If true, 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.
    type_name str
    Standard file share type Available values: "standard", "vast".
    allowedCharacters String
    Available values: "LCD", "NPL".
    pathLength String
    Available values: "LCD", "NPL".
    rootSquash Boolean
    Enables or disables root squash for NFS clients.

    • If true, 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.
    typeName String
    Standard file share type Available values: "standard", "vast".

    GetCloudFileShareTag

    Key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    ReadOnly bool
    If true, the tag is read-only and cannot be modified by the user
    Value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    Key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    ReadOnly bool
    If true, the tag is read-only and cannot be modified by the user
    Value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key String
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    readOnly Boolean
    If true, the tag is read-only and cannot be modified by the user
    value String
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    readOnly boolean
    If true, the tag is read-only and cannot be modified by the user
    value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key str
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    read_only bool
    If true, the tag is read-only and cannot be modified by the user
    value str
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key String
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    readOnly Boolean
    If true, the tag is read-only and cannot be modified by the user
    value String
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

    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.