1. Packages
  2. UpCloud
  3. API Docs
  4. FileStorageShare
UpCloud v0.10.2 published on Friday, Jan 23, 2026 by UpCloudLtd
upcloud logo
UpCloud v0.10.2 published on Friday, Jan 23, 2026 by UpCloudLtd

    This resource represents a File Storage service.

    Create FileStorageShare Resource

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

    Constructor syntax

    new FileStorageShare(name: string, args: FileStorageShareArgs, opts?: CustomResourceOptions);
    @overload
    def FileStorageShare(resource_name: str,
                         args: FileStorageShareArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def FileStorageShare(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         file_storage: Optional[str] = None,
                         path: Optional[str] = None,
                         name: Optional[str] = None)
    func NewFileStorageShare(ctx *Context, name string, args FileStorageShareArgs, opts ...ResourceOption) (*FileStorageShare, error)
    public FileStorageShare(string name, FileStorageShareArgs args, CustomResourceOptions? opts = null)
    public FileStorageShare(String name, FileStorageShareArgs args)
    public FileStorageShare(String name, FileStorageShareArgs args, CustomResourceOptions options)
    
    type: upcloud:FileStorageShare
    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 FileStorageShareArgs
    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 FileStorageShareArgs
    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 FileStorageShareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileStorageShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileStorageShareArgs
    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 fileStorageShareResource = new UpCloud.FileStorageShare("fileStorageShareResource", new()
    {
        FileStorage = "string",
        Path = "string",
        Name = "string",
    });
    
    example, err := upcloud.NewFileStorageShare(ctx, "fileStorageShareResource", &upcloud.FileStorageShareArgs{
    	FileStorage: pulumi.String("string"),
    	Path:        pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var fileStorageShareResource = new FileStorageShare("fileStorageShareResource", FileStorageShareArgs.builder()
        .fileStorage("string")
        .path("string")
        .name("string")
        .build());
    
    file_storage_share_resource = upcloud.FileStorageShare("fileStorageShareResource",
        file_storage="string",
        path="string",
        name="string")
    
    const fileStorageShareResource = new upcloud.FileStorageShare("fileStorageShareResource", {
        fileStorage: "string",
        path: "string",
        name: "string",
    });
    
    type: upcloud:FileStorageShare
    properties:
        fileStorage: string
        name: string
        path: string
    

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

    FileStorage string
    UUID of the file storage service.
    Path string
    Absolute path exported by the share (e.g. /public).
    Name string
    Unique name of the share (1–64 chars).
    FileStorage string
    UUID of the file storage service.
    Path string
    Absolute path exported by the share (e.g. /public).
    Name string
    Unique name of the share (1–64 chars).
    fileStorage String
    UUID of the file storage service.
    path String
    Absolute path exported by the share (e.g. /public).
    name String
    Unique name of the share (1–64 chars).
    fileStorage string
    UUID of the file storage service.
    path string
    Absolute path exported by the share (e.g. /public).
    name string
    Unique name of the share (1–64 chars).
    file_storage str
    UUID of the file storage service.
    path str
    Absolute path exported by the share (e.g. /public).
    name str
    Unique name of the share (1–64 chars).
    fileStorage String
    UUID of the file storage service.
    path String
    Absolute path exported by the share (e.g. /public).
    name String
    Unique name of the share (1–64 chars).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FileStorageShare Resource

    Get an existing FileStorageShare 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?: FileStorageShareState, opts?: CustomResourceOptions): FileStorageShare
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            file_storage: Optional[str] = None,
            name: Optional[str] = None,
            path: Optional[str] = None) -> FileStorageShare
    func GetFileStorageShare(ctx *Context, name string, id IDInput, state *FileStorageShareState, opts ...ResourceOption) (*FileStorageShare, error)
    public static FileStorageShare Get(string name, Input<string> id, FileStorageShareState? state, CustomResourceOptions? opts = null)
    public static FileStorageShare get(String name, Output<String> id, FileStorageShareState state, CustomResourceOptions options)
    resources:  _:    type: upcloud:FileStorageShare    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:
    FileStorage string
    UUID of the file storage service.
    Name string
    Unique name of the share (1–64 chars).
    Path string
    Absolute path exported by the share (e.g. /public).
    FileStorage string
    UUID of the file storage service.
    Name string
    Unique name of the share (1–64 chars).
    Path string
    Absolute path exported by the share (e.g. /public).
    fileStorage String
    UUID of the file storage service.
    name String
    Unique name of the share (1–64 chars).
    path String
    Absolute path exported by the share (e.g. /public).
    fileStorage string
    UUID of the file storage service.
    name string
    Unique name of the share (1–64 chars).
    path string
    Absolute path exported by the share (e.g. /public).
    file_storage str
    UUID of the file storage service.
    name str
    Unique name of the share (1–64 chars).
    path str
    Absolute path exported by the share (e.g. /public).
    fileStorage String
    UUID of the file storage service.
    name String
    Unique name of the share (1–64 chars).
    path String
    Absolute path exported by the share (e.g. /public).

    Package Details

    Repository
    upcloud UpCloudLtd/pulumi-upcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the upcloud Terraform Provider.
    upcloud logo
    UpCloud v0.10.2 published on Friday, Jan 23, 2026 by UpCloudLtd
      Meet Neo: Your AI Platform Teammate