UNPKG

@pulumiverse/scaleway

Version:

A Pulumi package for creating and managing Scaleway cloud resources.

175 lines 6.65 kB
import * as pulumi from "@pulumi/pulumi"; /** * > **This product is currently in private beta. To request access, please contact your Technical Account Manager.** * * Creates and manages a Scaleway File Storage filesystem in a specific region. A filesystem is a scalable storage resource that can be mounted on Compute instances and is typically used for share persistent storage between multiple instances (RWX). * * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * * const file = new scaleway.FileFilesystem("file", { * name: "my-nfs-filesystem", * sizeInGb: 100, * }); * ``` * * ## Import * * File Storage filesystems can be imported using the `{region}/{id}`, e.g. * * ```sh * $ pulumi import scaleway:index/fileFilesystem:FileFilesystem main fr-par/11111111-1111-1111-1111-111111111111 * ``` */ export declare class FileFilesystem extends pulumi.CustomResource { /** * Get an existing FileFilesystem resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FileFilesystemState, opts?: pulumi.CustomResourceOptions): FileFilesystem; /** * Returns true if the given object is an instance of FileFilesystem. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is FileFilesystem; /** * The date and time when the File Storage filesystem was created. */ readonly createdAt: pulumi.Output<string>; /** * The name of the filesystem. If not provided, a random name will be generated. */ readonly name: pulumi.Output<string>; /** * The number of active attachments (mounts) on the filesystem. */ readonly numberOfAttachments: pulumi.Output<number>; /** * `organizationId`) The ID of the organization the user is associated with. */ readonly organizationId: pulumi.Output<string>; /** * `projectId`) The ID of the project the server is * associated with. */ readonly projectId: pulumi.Output<string>; /** * `region`) The region where the filesystem will be created (e.g., fr-par, nl-ams). */ readonly region: pulumi.Output<string | undefined>; /** * 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) */ readonly sizeInGb: pulumi.Output<number>; /** * The current status of the filesystem. Possible values include creating, available, etc. */ readonly status: pulumi.Output<string>; /** * A list of tags associated with the filesystem. */ readonly tags: pulumi.Output<string[] | undefined>; /** * The date and time of the last update to the File Storage filesystem. */ readonly updatedAt: pulumi.Output<string>; /** * Create a FileFilesystem resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: FileFilesystemArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering FileFilesystem resources. */ export interface FileFilesystemState { /** * The date and time when the File Storage filesystem was created. */ createdAt?: pulumi.Input<string | undefined>; /** * The name of the filesystem. If not provided, a random name will be generated. */ name?: pulumi.Input<string | undefined>; /** * The number of active attachments (mounts) on the filesystem. */ numberOfAttachments?: pulumi.Input<number | undefined>; /** * `organizationId`) The ID of the organization the user is associated with. */ organizationId?: pulumi.Input<string | undefined>; /** * `projectId`) The ID of the project the server is * associated with. */ projectId?: pulumi.Input<string | undefined>; /** * `region`) The region where the filesystem will be created (e.g., fr-par, nl-ams). */ region?: pulumi.Input<string | undefined>; /** * 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) */ sizeInGb?: pulumi.Input<number | undefined>; /** * The current status of the filesystem. Possible values include creating, available, etc. */ status?: pulumi.Input<string | undefined>; /** * A list of tags associated with the filesystem. */ tags?: pulumi.Input<pulumi.Input<string>[] | undefined>; /** * The date and time of the last update to the File Storage filesystem. */ updatedAt?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a FileFilesystem resource. */ export interface FileFilesystemArgs { /** * The name of the filesystem. If not provided, a random name will be generated. */ name?: pulumi.Input<string | undefined>; /** * `projectId`) The ID of the project the server is * associated with. */ projectId?: pulumi.Input<string | undefined>; /** * `region`) The region where the filesystem will be created (e.g., fr-par, nl-ams). */ region?: pulumi.Input<string | undefined>; /** * 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) */ sizeInGb: pulumi.Input<number>; /** * A list of tags associated with the filesystem. */ tags?: pulumi.Input<pulumi.Input<string>[] | undefined>; } //# sourceMappingURL=fileFilesystem.d.ts.map