Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. FileFilesystem
Scaleway v1.31.0 published on Thursday, Jul 10, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.FileFilesystem

Explore with Pulumi AI

scaleway logo
Scaleway v1.31.0 published on Thursday, Jul 10, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

    Creates and manages a Scaleway File Storage (NFS) filesystem in a specific region. A filesystem is a scalable storage resource that can be mounted on Compute instances and is typically used for shared, persistent storage.

    This resource allows you to define and manage the size, tags, and region of a filesystem, and track its creation and update timestamps, current status, and number of active attachments.

    Example Usage

    Basic

    import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const file = new scaleway.FileFilesystem("file", {
    name: "my-nfs-filesystem",
    size: 100000000000,
});

    import pulumi
import pulumiverse_scaleway as scaleway

file = scaleway.FileFilesystem("file",
    name="my-nfs-filesystem",
    size=100000000000)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scaleway.NewFileFilesystem(ctx, "file", &scaleway.FileFilesystemArgs{
			Name: pulumi.String("my-nfs-filesystem"),
			Size: pulumi.Int(100000000000),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var file = new Scaleway.FileFilesystem("file", new()
    {
        Name = "my-nfs-filesystem",
        Size = 100000000000,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.FileFilesystem;
import com.pulumi.scaleway.FileFilesystemArgs;
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 file = new FileFilesystem("file", FileFilesystemArgs.builder()
            .name("my-nfs-filesystem")
            .size(100000000000)
            .build());

    }
}

    resources:
  file:
    type: scaleway:FileFilesystem
    properties:
      name: my-nfs-filesystem
      size: 1e+11 # 100 GB

    Create FileFilesystem Resource

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

    Constructor syntax

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

@overload
def FileFilesystem(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   size: Optional[int] = None,
                   name: Optional[str] = None,
                   project_id: Optional[str] = None,
                   region: Optional[str] = None,
                   tags: Optional[Sequence[str]] = None)
    func NewFileFilesystem(ctx *Context, name string, args FileFilesystemArgs, opts ...ResourceOption) (*FileFilesystem, error)
    public FileFilesystem(string name, FileFilesystemArgs args, CustomResourceOptions? opts = null)
    public FileFilesystem(String name, FileFilesystemArgs args)
public FileFilesystem(String name, FileFilesystemArgs args, CustomResourceOptions options)

    type: scaleway:FileFilesystem
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 FileFilesystemArgs
    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 FileFilesystemArgs
    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 FileFilesystemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileFilesystemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileFilesystemArgs
    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 fileFilesystemResource = new Scaleway.FileFilesystem("fileFilesystemResource", new()
{
    Size = 0,
    Name = "string",
    ProjectId = "string",
    Region = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := scaleway.NewFileFilesystem(ctx, "fileFilesystemResource", &scaleway.FileFilesystemArgs{
	Size:      pulumi.Int(0),
	Name:      pulumi.String("string"),
	ProjectId: pulumi.String("string"),
	Region:    pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var fileFilesystemResource = new FileFilesystem("fileFilesystemResource", FileFilesystemArgs.builder()
    .size(0)
    .name("string")
    .projectId("string")
    .region("string")
    .tags("string")
    .build());

    file_filesystem_resource = scaleway.FileFilesystem("fileFilesystemResource",
    size=0,
    name="string",
    project_id="string",
    region="string",
    tags=["string"])

    const fileFilesystemResource = new scaleway.FileFilesystem("fileFilesystemResource", {
    size: 0,
    name: "string",
    projectId: "string",
    region: "string",
    tags: ["string"],
});

    type: scaleway:FileFilesystem
properties:
    name: string
    projectId: string
    region: string
    size: 0
    tags:
        - string

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

    Size int
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    Name string
    The name of the filesystem. If not provided, a random name will be generated.
    ProjectId string
    project_id) The ID of the project the server is associated with.
    Region string
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    Tags List<string>
    A list of tags associated with the filesystem.
    Size int
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    Name string
    The name of the filesystem. If not provided, a random name will be generated.
    ProjectId string
    project_id) The ID of the project the server is associated with.
    Region string
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    Tags []string
    A list of tags associated with the filesystem.
    size Integer
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    name String
    The name of the filesystem. If not provided, a random name will be generated.
    projectId String
    project_id) The ID of the project the server is associated with.
    region String
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    tags List<String>
    A list of tags associated with the filesystem.
    size number
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    name string
    The name of the filesystem. If not provided, a random name will be generated.
    projectId string
    project_id) The ID of the project the server is associated with.
    region string
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    tags string[]
    A list of tags associated with the filesystem.
    size int
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    name str
    The name of the filesystem. If not provided, a random name will be generated.
    project_id str
    project_id) The ID of the project the server is associated with.
    region str
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    tags Sequence[str]
    A list of tags associated with the filesystem.
    size Number
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    name String
    The name of the filesystem. If not provided, a random name will be generated.
    projectId String
    project_id) The ID of the project the server is associated with.
    region String
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    tags List<String>
    A list of tags associated with the filesystem.

    Outputs

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

    CreatedAt string
    The date and time when the File Storage filesystem was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    NumberOfAttachments int
    The number of active attachments (mounts) on the filesystem.
    OrganizationId string
    organization_id) The ID of the organization the user is associated with.
    Status string
    The current status of the filesystem. Possible values include creating, available, etc.
    UpdatedAt string
    The date and time of the last update to the File Storage filesystem.
    CreatedAt string
    The date and time when the File Storage filesystem was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    NumberOfAttachments int
    The number of active attachments (mounts) on the filesystem.
    OrganizationId string
    organization_id) The ID of the organization the user is associated with.
    Status string
    The current status of the filesystem. Possible values include creating, available, etc.
    UpdatedAt string
    The date and time of the last update to the File Storage filesystem.
    createdAt String
    The date and time when the File Storage filesystem was created.
    id String
    The provider-assigned unique ID for this managed resource.
    numberOfAttachments Integer
    The number of active attachments (mounts) on the filesystem.
    organizationId String
    organization_id) The ID of the organization the user is associated with.
    status String
    The current status of the filesystem. Possible values include creating, available, etc.
    updatedAt String
    The date and time of the last update to the File Storage filesystem.
    createdAt string
    The date and time when the File Storage filesystem was created.
    id string
    The provider-assigned unique ID for this managed resource.
    numberOfAttachments number
    The number of active attachments (mounts) on the filesystem.
    organizationId string
    organization_id) The ID of the organization the user is associated with.
    status string
    The current status of the filesystem. Possible values include creating, available, etc.
    updatedAt string
    The date and time of the last update to the File Storage filesystem.
    created_at str
    The date and time when the File Storage filesystem was created.
    id str
    The provider-assigned unique ID for this managed resource.
    number_of_attachments int
    The number of active attachments (mounts) on the filesystem.
    organization_id str
    organization_id) The ID of the organization the user is associated with.
    status str
    The current status of the filesystem. Possible values include creating, available, etc.
    updated_at str
    The date and time of the last update to the File Storage filesystem.
    createdAt String
    The date and time when the File Storage filesystem was created.
    id String
    The provider-assigned unique ID for this managed resource.
    numberOfAttachments Number
    The number of active attachments (mounts) on the filesystem.
    organizationId String
    organization_id) The ID of the organization the user is associated with.
    status String
    The current status of the filesystem. Possible values include creating, available, etc.
    updatedAt String
    The date and time of the last update to the File Storage filesystem.

    Look up Existing FileFilesystem Resource

    Get an existing FileFilesystem 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?: FileFilesystemState, opts?: CustomResourceOptions): FileFilesystem
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        name: Optional[str] = None,
        number_of_attachments: Optional[int] = None,
        organization_id: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        size: Optional[int] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None) -> FileFilesystem
    func GetFileFilesystem(ctx *Context, name string, id IDInput, state *FileFilesystemState, opts ...ResourceOption) (*FileFilesystem, error)
    public static FileFilesystem Get(string name, Input<string> id, FileFilesystemState? state, CustomResourceOptions? opts = null)
    public static FileFilesystem get(String name, Output<String> id, FileFilesystemState state, CustomResourceOptions options)
    resources:  _:    type: scaleway:FileFilesystem    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:
    CreatedAt string
    The date and time when the File Storage filesystem was created.
    Name string
    The name of the filesystem. If not provided, a random name will be generated.
    NumberOfAttachments int
    The number of active attachments (mounts) on the filesystem.
    OrganizationId string
    organization_id) The ID of the organization the user is associated with.
    ProjectId string
    project_id) The ID of the project the server is associated with.
    Region string
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    Size int
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    Status string
    The current status of the filesystem. Possible values include creating, available, etc.
    Tags List<string>
    A list of tags associated with the filesystem.
    UpdatedAt string
    The date and time of the last update to the File Storage filesystem.
    CreatedAt string
    The date and time when the File Storage filesystem was created.
    Name string
    The name of the filesystem. If not provided, a random name will be generated.
    NumberOfAttachments int
    The number of active attachments (mounts) on the filesystem.
    OrganizationId string
    organization_id) The ID of the organization the user is associated with.
    ProjectId string
    project_id) The ID of the project the server is associated with.
    Region string
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    Size int
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    Status string
    The current status of the filesystem. Possible values include creating, available, etc.
    Tags []string
    A list of tags associated with the filesystem.
    UpdatedAt string
    The date and time of the last update to the File Storage filesystem.
    createdAt String
    The date and time when the File Storage filesystem was created.
    name String
    The name of the filesystem. If not provided, a random name will be generated.
    numberOfAttachments Integer
    The number of active attachments (mounts) on the filesystem.
    organizationId String
    organization_id) The ID of the organization the user is associated with.
    projectId String
    project_id) The ID of the project the server is associated with.
    region String
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    size Integer
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    status String
    The current status of the filesystem. Possible values include creating, available, etc.
    tags List<String>
    A list of tags associated with the filesystem.
    updatedAt String
    The date and time of the last update to the File Storage filesystem.
    createdAt string
    The date and time when the File Storage filesystem was created.
    name string
    The name of the filesystem. If not provided, a random name will be generated.
    numberOfAttachments number
    The number of active attachments (mounts) on the filesystem.
    organizationId string
    organization_id) The ID of the organization the user is associated with.
    projectId string
    project_id) The ID of the project the server is associated with.
    region string
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    size number
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    status string
    The current status of the filesystem. Possible values include creating, available, etc.
    tags string[]
    A list of tags associated with the filesystem.
    updatedAt string
    The date and time of the last update to the File Storage filesystem.
    created_at str
    The date and time when the File Storage filesystem was created.
    name str
    The name of the filesystem. If not provided, a random name will be generated.
    number_of_attachments int
    The number of active attachments (mounts) on the filesystem.
    organization_id str
    organization_id) The ID of the organization the user is associated with.
    project_id str
    project_id) The ID of the project the server is associated with.
    region str
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    size int
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    status str
    The current status of the filesystem. Possible values include creating, available, etc.
    tags Sequence[str]
    A list of tags associated with the filesystem.
    updated_at str
    The date and time of the last update to the File Storage filesystem.
    createdAt String
    The date and time when the File Storage filesystem was created.
    name String
    The name of the filesystem. If not provided, a random name will be generated.
    numberOfAttachments Number
    The number of active attachments (mounts) on the filesystem.
    organizationId String
    organization_id) The ID of the organization the user is associated with.
    projectId String
    project_id) The ID of the project the server is associated with.
    region String
    region) The region where the filesystem will be created (e.g., fr-par, nl-ams).
    size Number
    The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).

    • Minimum: 100 GB (100000000000 bytes)
    • Maximum: 10 TB (10000000000000 bytes)
    status String
    The current status of the filesystem. Possible values include creating, available, etc.
    tags List<String>
    A list of tags associated with the filesystem.
    updatedAt String
    The date and time of the last update to the File Storage filesystem.

    Import

    File Storage filesystems can be imported using the {region}/{id}, e.g.

    bash

    $ pulumi import scaleway:index/fileFilesystem:FileFilesystem main fr-par/11111111-1111-1111-1111-111111111111

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

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.31.0 published on Thursday, Jul 10, 2025 by pulumiverse
    pulumiverse/pulumi-scaleway