Alibaba Cloud v3.78.0, May 16 25

Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi

alicloud.nas.FileSystem

Explore with Pulumi AI

Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi

pulumi/pulumi-alicloud

Example Usage

Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = alicloud.nas.getZones({
    fileSystemType: "standard",
});
const defaultFileSystem = new alicloud.nas.FileSystem("default", {
    protocolType: "NFS",
    storageType: "Capacity",
    description: name,
    encryptType: 1,
    fileSystemType: "standard",
    recycleBin: {
        status: "Enable",
        reservedDays: 10,
    },
    nfsAcl: {
        enabled: true,
    },
    zoneId: _default.then(_default => _default.zones?.[0]?.zoneId),
});

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.nas.get_zones(file_system_type="standard")
default_file_system = alicloud.nas.FileSystem("default",
    protocol_type="NFS",
    storage_type="Capacity",
    description=name,
    encrypt_type=1,
    file_system_type="standard",
    recycle_bin={
        "status": "Enable",
        "reserved_days": 10,
    },
    nfs_acl={
        "enabled": True,
    },
    zone_id=default.zones[0].zone_id)

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/nas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := nas.GetZones(ctx, &nas.GetZonesArgs{
			FileSystemType: pulumi.StringRef("standard"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = nas.NewFileSystem(ctx, "default", &nas.FileSystemArgs{
			ProtocolType:   pulumi.String("NFS"),
			StorageType:    pulumi.String("Capacity"),
			Description:    pulumi.String(name),
			EncryptType:    pulumi.Int(1),
			FileSystemType: pulumi.String("standard"),
			RecycleBin: &nas.FileSystemRecycleBinArgs{
				Status:       pulumi.String("Enable"),
				ReservedDays: pulumi.Int(10),
			},
			NfsAcl: &nas.FileSystemNfsAclArgs{
				Enabled: pulumi.Bool(true),
			},
			ZoneId: pulumi.String(_default.Zones[0].ZoneId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = AliCloud.Nas.GetZones.Invoke(new()
    {
        FileSystemType = "standard",
    });

    var defaultFileSystem = new AliCloud.Nas.FileSystem("default", new()
    {
        ProtocolType = "NFS",
        StorageType = "Capacity",
        Description = name,
        EncryptType = 1,
        FileSystemType = "standard",
        RecycleBin = new AliCloud.Nas.Inputs.FileSystemRecycleBinArgs
        {
            Status = "Enable",
            ReservedDays = 10,
        },
        NfsAcl = new AliCloud.Nas.Inputs.FileSystemNfsAclArgs
        {
            Enabled = true,
        },
        ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones[0]?.ZoneId)),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.nas.NasFunctions;
import com.pulumi.alicloud.nas.inputs.GetZonesArgs;
import com.pulumi.alicloud.nas.FileSystem;
import com.pulumi.alicloud.nas.FileSystemArgs;
import com.pulumi.alicloud.nas.inputs.FileSystemRecycleBinArgs;
import com.pulumi.alicloud.nas.inputs.FileSystemNfsAclArgs;
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 config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        final var default = NasFunctions.getZones(GetZonesArgs.builder()
            .fileSystemType("standard")
            .build());

        var defaultFileSystem = new FileSystem("defaultFileSystem", FileSystemArgs.builder()
            .protocolType("NFS")
            .storageType("Capacity")
            .description(name)
            .encryptType(1)
            .fileSystemType("standard")
            .recycleBin(FileSystemRecycleBinArgs.builder()
                .status("Enable")
                .reservedDays(10)
                .build())
            .nfsAcl(FileSystemNfsAclArgs.builder()
                .enabled(true)
                .build())
            .zoneId(default_.zones()[0].zoneId())
            .build());

    }
}

configuration:
  name:
    type: string
    default: terraform-example
resources:
  defaultFileSystem:
    type: alicloud:nas:FileSystem
    name: default
    properties:
      protocolType: NFS
      storageType: Capacity
      description: ${name}
      encryptType: 1
      fileSystemType: standard
      recycleBin:
        status: Enable
        reservedDays: '10'
      nfsAcl:
        enabled: true
      zoneId: ${default.zones[0].zoneId}
variables:
  default:
    fn::invoke:
      function: alicloud:nas:getZones
      arguments:
        fileSystemType: standard

Create FileSystem Resource

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

Constructor syntax

new FileSystem(name: string, args: FileSystemArgs, opts?: CustomResourceOptions);

@overload
def FileSystem(resource_name: str,
               args: FileSystemArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def FileSystem(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               protocol_type: Optional[str] = None,
               storage_type: Optional[str] = None,
               options: Optional[FileSystemOptionsArgs] = None,
               resource_group_id: Optional[str] = None,
               keytab: Optional[str] = None,
               keytab_md5: Optional[str] = None,
               kms_key_id: Optional[str] = None,
               nfs_acl: Optional[FileSystemNfsAclArgs] = None,
               capacity: Optional[int] = None,
               encrypt_type: Optional[int] = None,
               recycle_bin: Optional[FileSystemRecycleBinArgs] = None,
               file_system_type: Optional[str] = None,
               smb_acl: Optional[FileSystemSmbAclArgs] = None,
               snapshot_id: Optional[str] = None,
               description: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               vpc_id: Optional[str] = None,
               vswitch_id: Optional[str] = None,
               zone_id: Optional[str] = None)

func NewFileSystem(ctx *Context, name string, args FileSystemArgs, opts ...ResourceOption) (*FileSystem, error)

public FileSystem(string name, FileSystemArgs args, CustomResourceOptions? opts = null)

public FileSystem(String name, FileSystemArgs args)
public FileSystem(String name, FileSystemArgs args, CustomResourceOptions options)

type: alicloud:nas:FileSystem
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 FileSystemArgs: 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 FileSystemArgs: 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 FileSystemArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FileSystemArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args FileSystemArgs: 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 alicloudFileSystemResource = new AliCloud.Nas.FileSystem("alicloudFileSystemResource", new()
{
    ProtocolType = "string",
    StorageType = "string",
    Options = new AliCloud.Nas.Inputs.FileSystemOptionsArgs
    {
        EnableOplock = false,
    },
    ResourceGroupId = "string",
    Keytab = "string",
    KeytabMd5 = "string",
    KmsKeyId = "string",
    NfsAcl = new AliCloud.Nas.Inputs.FileSystemNfsAclArgs
    {
        Enabled = false,
    },
    Capacity = 0,
    EncryptType = 0,
    RecycleBin = new AliCloud.Nas.Inputs.FileSystemRecycleBinArgs
    {
        EnableTime = "string",
        ReservedDays = 0,
        SecondarySize = 0,
        Size = 0,
        Status = "string",
    },
    FileSystemType = "string",
    SmbAcl = new AliCloud.Nas.Inputs.FileSystemSmbAclArgs
    {
        EnableAnonymousAccess = false,
        Enabled = false,
        EncryptData = false,
        HomeDirPath = "string",
        RejectUnencryptedAccess = false,
        SuperAdminSid = "string",
    },
    SnapshotId = "string",
    Description = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VpcId = "string",
    VswitchId = "string",
    ZoneId = "string",
});

example, err := nas.NewFileSystem(ctx, "alicloudFileSystemResource", &nas.FileSystemArgs{
	ProtocolType: pulumi.String("string"),
	StorageType:  pulumi.String("string"),
	Options: &nas.FileSystemOptionsArgs{
		EnableOplock: pulumi.Bool(false),
	},
	ResourceGroupId: pulumi.String("string"),
	Keytab:          pulumi.String("string"),
	KeytabMd5:       pulumi.String("string"),
	KmsKeyId:        pulumi.String("string"),
	NfsAcl: &nas.FileSystemNfsAclArgs{
		Enabled: pulumi.Bool(false),
	},
	Capacity:    pulumi.Int(0),
	EncryptType: pulumi.Int(0),
	RecycleBin: &nas.FileSystemRecycleBinArgs{
		EnableTime:    pulumi.String("string"),
		ReservedDays:  pulumi.Int(0),
		SecondarySize: pulumi.Int(0),
		Size:          pulumi.Int(0),
		Status:        pulumi.String("string"),
	},
	FileSystemType: pulumi.String("string"),
	SmbAcl: &nas.FileSystemSmbAclArgs{
		EnableAnonymousAccess:   pulumi.Bool(false),
		Enabled:                 pulumi.Bool(false),
		EncryptData:             pulumi.Bool(false),
		HomeDirPath:             pulumi.String("string"),
		RejectUnencryptedAccess: pulumi.Bool(false),
		SuperAdminSid:           pulumi.String("string"),
	},
	SnapshotId:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcId:     pulumi.String("string"),
	VswitchId: pulumi.String("string"),
	ZoneId:    pulumi.String("string"),
})

var alicloudFileSystemResource = new com.pulumi.alicloud.nas.FileSystem("alicloudFileSystemResource", com.pulumi.alicloud.nas.FileSystemArgs.builder()
    .protocolType("string")
    .storageType("string")
    .options(FileSystemOptionsArgs.builder()
        .enableOplock(false)
        .build())
    .resourceGroupId("string")
    .keytab("string")
    .keytabMd5("string")
    .kmsKeyId("string")
    .nfsAcl(FileSystemNfsAclArgs.builder()
        .enabled(false)
        .build())
    .capacity(0)
    .encryptType(0)
    .recycleBin(FileSystemRecycleBinArgs.builder()
        .enableTime("string")
        .reservedDays(0)
        .secondarySize(0)
        .size(0)
        .status("string")
        .build())
    .fileSystemType("string")
    .smbAcl(FileSystemSmbAclArgs.builder()
        .enableAnonymousAccess(false)
        .enabled(false)
        .encryptData(false)
        .homeDirPath("string")
        .rejectUnencryptedAccess(false)
        .superAdminSid("string")
        .build())
    .snapshotId("string")
    .description("string")
    .tags(Map.of("string", "string"))
    .vpcId("string")
    .vswitchId("string")
    .zoneId("string")
    .build());

alicloud_file_system_resource = alicloud.nas.FileSystem("alicloudFileSystemResource",
    protocol_type="string",
    storage_type="string",
    options={
        "enable_oplock": False,
    },
    resource_group_id="string",
    keytab="string",
    keytab_md5="string",
    kms_key_id="string",
    nfs_acl={
        "enabled": False,
    },
    capacity=0,
    encrypt_type=0,
    recycle_bin={
        "enable_time": "string",
        "reserved_days": 0,
        "secondary_size": 0,
        "size": 0,
        "status": "string",
    },
    file_system_type="string",
    smb_acl={
        "enable_anonymous_access": False,
        "enabled": False,
        "encrypt_data": False,
        "home_dir_path": "string",
        "reject_unencrypted_access": False,
        "super_admin_sid": "string",
    },
    snapshot_id="string",
    description="string",
    tags={
        "string": "string",
    },
    vpc_id="string",
    vswitch_id="string",
    zone_id="string")

const alicloudFileSystemResource = new alicloud.nas.FileSystem("alicloudFileSystemResource", {
    protocolType: "string",
    storageType: "string",
    options: {
        enableOplock: false,
    },
    resourceGroupId: "string",
    keytab: "string",
    keytabMd5: "string",
    kmsKeyId: "string",
    nfsAcl: {
        enabled: false,
    },
    capacity: 0,
    encryptType: 0,
    recycleBin: {
        enableTime: "string",
        reservedDays: 0,
        secondarySize: 0,
        size: 0,
        status: "string",
    },
    fileSystemType: "string",
    smbAcl: {
        enableAnonymousAccess: false,
        enabled: false,
        encryptData: false,
        homeDirPath: "string",
        rejectUnencryptedAccess: false,
        superAdminSid: "string",
    },
    snapshotId: "string",
    description: "string",
    tags: {
        string: "string",
    },
    vpcId: "string",
    vswitchId: "string",
    zoneId: "string",
});

type: alicloud:nas:FileSystem
properties:
    capacity: 0
    description: string
    encryptType: 0
    fileSystemType: string
    keytab: string
    keytabMd5: string
    kmsKeyId: string
    nfsAcl:
        enabled: false
    options:
        enableOplock: false
    protocolType: string
    recycleBin:
        enableTime: string
        reservedDays: 0
        secondarySize: 0
        size: 0
        status: string
    resourceGroupId: string
    smbAcl:
        enableAnonymousAccess: false
        enabled: false
        encryptData: false
        homeDirPath: string
        rejectUnencryptedAccess: false
        superAdminSid: string
    snapshotId: string
    storageType: string
    tags:
        string: string
    vpcId: string
    vswitchId: string
    zoneId: string

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

ProtocolType string

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

StorageType string

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

Capacity int

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

For optional values, please refer to the actual specifications on the purchase page: -[Fast NAS Pay-As-You-Go Page](https://common-buy.aliyun.com/? commodityCode=nas_extreme_post#/buy) -[Fast NAS Package Monthly Purchase Page](https://common-buy.aliyun.com/? commodityCode=nas_extreme#/buy) -[Parallel File System CPFS Pay-As-You-Go Purchase Page](https://common-buy.aliyun.com/? commodityCode=nas_cpfs_post#/buy) -[Parallel File System CPFS Package Monthly Purchase Page](https://common-buy.aliyun.com/? commodityCode=cpfs#/buy)

Description string

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

EncryptType int

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

FileSystemType string

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

Keytab string

String of keytab file content encrypted by base64

KeytabMd5 string

String of the keytab file content encrypted by MD5

KmsKeyId string

The ID of the KMS key. This parameter is required only when EncryptType = 2.

NfsAcl Pulumi.AliCloud.Nas.Inputs.FileSystemNfsAcl

NFS ACL See nfs_acl below.

Options Pulumi.AliCloud.Nas.Inputs.FileSystemOptions

Option. See options below.

RecycleBin Pulumi.AliCloud.Nas.Inputs.FileSystemRecycleBin

Recycle Bin See recycle_bin below.

ResourceGroupId string

The ID of the resource group.

SmbAcl Pulumi.AliCloud.Nas.Inputs.FileSystemSmbAcl

SMB ACL See smb_acl below.

SnapshotId string

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

Tags Dictionary<string, string>

Label information collection.

VpcId string

The ID of the VPC network. This parameter must be configured when FileSystemType = cpfs. When the FileSystemType is standard or extreme, this parameter is reserved for the interface and has not taken effect yet. You do not need to configure it.

VswitchId string

The ID of the switch. This parameter must be configured when FileSystemType = cpfs. When the FileSystemType is standard or extreme, this parameter is reserved for the interface and has not taken effect yet. You do not need to configure it.

ZoneId string

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

When the FileSystemType is set to standard, this parameter is optional. By default, a zone that meets the conditions is randomly selected based on the ProtocolType and StorageType configurations. This parameter is required when FileSystemType = extreme or FileSystemType = cpfs.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

ProtocolType string

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

StorageType string

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

Capacity int

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

Description string

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

EncryptType int

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

FileSystemType string

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

Keytab string

String of keytab file content encrypted by base64

KeytabMd5 string

String of the keytab file content encrypted by MD5

KmsKeyId string

The ID of the KMS key. This parameter is required only when EncryptType = 2.

NfsAcl FileSystemNfsAclArgs

NFS ACL See nfs_acl below.

Options FileSystemOptionsArgs

Option. See options below.

RecycleBin FileSystemRecycleBinArgs

Recycle Bin See recycle_bin below.

ResourceGroupId string

The ID of the resource group.

SmbAcl FileSystemSmbAclArgs

SMB ACL See smb_acl below.

SnapshotId string

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

Tags map[string]string

Label information collection.

VpcId string

VswitchId string

ZoneId string

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

protocolType String

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

storageType String

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

capacity Integer

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

description String

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

encryptType Integer

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

fileSystemType String

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

keytab String

String of keytab file content encrypted by base64

keytabMd5 String

String of the keytab file content encrypted by MD5

kmsKeyId String

The ID of the KMS key. This parameter is required only when EncryptType = 2.

nfsAcl FileSystemNfsAcl

NFS ACL See nfs_acl below.

options FileSystemOptions

Option. See options below.

recycleBin FileSystemRecycleBin

Recycle Bin See recycle_bin below.

resourceGroupId String

The ID of the resource group.

smbAcl FileSystemSmbAcl

SMB ACL See smb_acl below.

snapshotId String

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

tags Map<String,String>

Label information collection.

vpcId String

vswitchId String

zoneId String

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

protocolType string

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

storageType string

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

capacity number

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

description string

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

encryptType number

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

fileSystemType string

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

keytab string

String of keytab file content encrypted by base64

keytabMd5 string

String of the keytab file content encrypted by MD5

kmsKeyId string

The ID of the KMS key. This parameter is required only when EncryptType = 2.

nfsAcl FileSystemNfsAcl

NFS ACL See nfs_acl below.

options FileSystemOptions

Option. See options below.

recycleBin FileSystemRecycleBin

Recycle Bin See recycle_bin below.

resourceGroupId string

The ID of the resource group.

smbAcl FileSystemSmbAcl

SMB ACL See smb_acl below.

snapshotId string

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

tags {[key: string]: string}

Label information collection.

vpcId string

vswitchId string

zoneId string

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

protocol_type str

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

storage_type str

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

capacity int

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

description str

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

encrypt_type int

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

file_system_type str

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

keytab str

String of keytab file content encrypted by base64

keytab_md5 str

String of the keytab file content encrypted by MD5

kms_key_id str

The ID of the KMS key. This parameter is required only when EncryptType = 2.

nfs_acl FileSystemNfsAclArgs

NFS ACL See nfs_acl below.

options FileSystemOptionsArgs

Option. See options below.

recycle_bin FileSystemRecycleBinArgs

Recycle Bin See recycle_bin below.

resource_group_id str

The ID of the resource group.

smb_acl FileSystemSmbAclArgs

SMB ACL See smb_acl below.

snapshot_id str

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

tags Mapping[str, str]

Label information collection.

vpc_id str

vswitch_id str

zone_id str

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

protocolType String

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

storageType String

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

capacity Number

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

description String

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

encryptType Number

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

fileSystemType String

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

keytab String

String of keytab file content encrypted by base64

keytabMd5 String

String of the keytab file content encrypted by MD5

kmsKeyId String

The ID of the KMS key. This parameter is required only when EncryptType = 2.

nfsAcl Property Map

NFS ACL See nfs_acl below.

options Property Map

Option. See options below.

recycleBin Property Map

Recycle Bin See recycle_bin below.

resourceGroupId String

The ID of the resource group.

smbAcl Property Map

SMB ACL See smb_acl below.

snapshotId String

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

tags Map<String>

Label information collection.

vpcId String

vswitchId String

zoneId String

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

Outputs

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

CreateTime string: CreateTime
Id string: The provider-assigned unique ID for this managed resource.
RegionId string: RegionId
Status string: File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

CreateTime string: CreateTime
Id string: The provider-assigned unique ID for this managed resource.
RegionId string: RegionId
Status string: File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

createTime String: CreateTime
id String: The provider-assigned unique ID for this managed resource.
regionId String: RegionId
status String: File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

createTime string: CreateTime
id string: The provider-assigned unique ID for this managed resource.
regionId string: RegionId
status string: File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

create_time str: CreateTime
id str: The provider-assigned unique ID for this managed resource.
region_id str: RegionId
status str: File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

createTime String: CreateTime
id String: The provider-assigned unique ID for this managed resource.
regionId String: RegionId
status String: File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

Look up Existing FileSystem Resource

Get an existing FileSystem 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?: FileSystemState, opts?: CustomResourceOptions): FileSystem

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity: Optional[int] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        encrypt_type: Optional[int] = None,
        file_system_type: Optional[str] = None,
        keytab: Optional[str] = None,
        keytab_md5: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        nfs_acl: Optional[FileSystemNfsAclArgs] = None,
        options: Optional[FileSystemOptionsArgs] = None,
        protocol_type: Optional[str] = None,
        recycle_bin: Optional[FileSystemRecycleBinArgs] = None,
        region_id: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        smb_acl: Optional[FileSystemSmbAclArgs] = None,
        snapshot_id: Optional[str] = None,
        status: Optional[str] = None,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> FileSystem

func GetFileSystem(ctx *Context, name string, id IDInput, state *FileSystemState, opts ...ResourceOption) (*FileSystem, error)

public static FileSystem Get(string name, Input<string> id, FileSystemState? state, CustomResourceOptions? opts = null)

public static FileSystem get(String name, Output<String> id, FileSystemState state, CustomResourceOptions options)

resources:  _:    type: alicloud:nas:FileSystem    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:

Capacity int

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

CreateTime string

CreateTime

Description string

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

EncryptType int

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

FileSystemType string

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

Keytab string

String of keytab file content encrypted by base64

KeytabMd5 string

String of the keytab file content encrypted by MD5

KmsKeyId string

The ID of the KMS key. This parameter is required only when EncryptType = 2.

NfsAcl Pulumi.AliCloud.Nas.Inputs.FileSystemNfsAcl

NFS ACL See nfs_acl below.

Options Pulumi.AliCloud.Nas.Inputs.FileSystemOptions

Option. See options below.

ProtocolType string

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

RecycleBin Pulumi.AliCloud.Nas.Inputs.FileSystemRecycleBin

Recycle Bin See recycle_bin below.

RegionId string

RegionId

ResourceGroupId string

The ID of the resource group.

SmbAcl Pulumi.AliCloud.Nas.Inputs.FileSystemSmbAcl

SMB ACL See smb_acl below.

SnapshotId string

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

Status string

File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

StorageType string

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

Tags Dictionary<string, string>

Label information collection.

VpcId string

VswitchId string

ZoneId string

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

Capacity int

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

CreateTime string

CreateTime

Description string

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

EncryptType int

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

FileSystemType string

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

Keytab string

String of keytab file content encrypted by base64

KeytabMd5 string

String of the keytab file content encrypted by MD5

KmsKeyId string

The ID of the KMS key. This parameter is required only when EncryptType = 2.

NfsAcl FileSystemNfsAclArgs

NFS ACL See nfs_acl below.

Options FileSystemOptionsArgs

Option. See options below.

ProtocolType string

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

RecycleBin FileSystemRecycleBinArgs

Recycle Bin See recycle_bin below.

RegionId string

RegionId

ResourceGroupId string

The ID of the resource group.

SmbAcl FileSystemSmbAclArgs

SMB ACL See smb_acl below.

SnapshotId string

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

Status string

File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

StorageType string

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

Tags map[string]string

Label information collection.

VpcId string

VswitchId string

ZoneId string

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

capacity Integer

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

createTime String

CreateTime

description String

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

encryptType Integer

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

fileSystemType String

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

keytab String

String of keytab file content encrypted by base64

keytabMd5 String

String of the keytab file content encrypted by MD5

kmsKeyId String

The ID of the KMS key. This parameter is required only when EncryptType = 2.

nfsAcl FileSystemNfsAcl

NFS ACL See nfs_acl below.

options FileSystemOptions

Option. See options below.

protocolType String

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

recycleBin FileSystemRecycleBin

Recycle Bin See recycle_bin below.

regionId String

RegionId

resourceGroupId String

The ID of the resource group.

smbAcl FileSystemSmbAcl

SMB ACL See smb_acl below.

snapshotId String

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

status String

File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

storageType String

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

tags Map<String,String>

Label information collection.

vpcId String

vswitchId String

zoneId String

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

capacity number

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

createTime string

CreateTime

description string

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

encryptType number

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

fileSystemType string

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

keytab string

String of keytab file content encrypted by base64

keytabMd5 string

String of the keytab file content encrypted by MD5

kmsKeyId string

The ID of the KMS key. This parameter is required only when EncryptType = 2.

nfsAcl FileSystemNfsAcl

NFS ACL See nfs_acl below.

options FileSystemOptions

Option. See options below.

protocolType string

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

recycleBin FileSystemRecycleBin

Recycle Bin See recycle_bin below.

regionId string

RegionId

resourceGroupId string

The ID of the resource group.

smbAcl FileSystemSmbAcl

SMB ACL See smb_acl below.

snapshotId string

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

status string

File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

storageType string

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

tags {[key: string]: string}

Label information collection.

vpcId string

vswitchId string

zoneId string

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

capacity int

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

create_time str

CreateTime

description str

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

encrypt_type int

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

file_system_type str

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

keytab str

String of keytab file content encrypted by base64

keytab_md5 str

String of the keytab file content encrypted by MD5

kms_key_id str

The ID of the KMS key. This parameter is required only when EncryptType = 2.

nfs_acl FileSystemNfsAclArgs

NFS ACL See nfs_acl below.

options FileSystemOptionsArgs

Option. See options below.

protocol_type str

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

recycle_bin FileSystemRecycleBinArgs

Recycle Bin See recycle_bin below.

region_id str

RegionId

resource_group_id str

The ID of the resource group.

smb_acl FileSystemSmbAclArgs

SMB ACL See smb_acl below.

snapshot_id str

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

status str

File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

storage_type str

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

tags Mapping[str, str]

Label information collection.

vpc_id str

vswitch_id str

zone_id str

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

capacity Number

File system capacity.

Unit: GiB, required and valid when FileSystemType = extreme or cpfs.

createTime String

CreateTime

description String

File system description.

Restrictions:

2~128 English or Chinese characters in length.
Must start with upper and lower case letters or Chinese, and cannot start with'http: // 'and'https.
Can contain numbers, colons (:), underscores (_), or dashes (-).

encryptType Number

Whether the file system is encrypted.

Use the KMS service hosting key to encrypt and store the file system disk data. When reading and writing encrypted data, there is no need to decrypt it.

Value:

0 (default): not encrypted.
1:NAS managed key. NAS managed keys are supported when FileSystemType = standard or extreme.
2: User management key. You can manage keys only when FileSystemType = extreme.

fileSystemType String

File system type.

Value:

standard (default): Universal NAS
extreme: extreme NAS
cpfs: file storage CPFS

keytab String

String of keytab file content encrypted by base64

keytabMd5 String

String of the keytab file content encrypted by MD5

kmsKeyId String

The ID of the KMS key. This parameter is required only when EncryptType = 2.

nfsAcl Property Map

NFS ACL See nfs_acl below.

options Property Map

Option. See options below.

protocolType String

File transfer protocol type.

When FileSystemType = standard, the values are NFS and SMB.
When FileSystemType = extreme, the value is NFS.
When FileSystemType = cpfs, the value is cpfs.

recycleBin Property Map

Recycle Bin See recycle_bin below.

regionId String

RegionId

resourceGroupId String

The ID of the resource group.

smbAcl Property Map

SMB ACL See smb_acl below.

snapshotId String

Only extreme NAS is supported.

NOTE: A file system is created from a snapshot. The version of the created file system is the same as that of the snapshot source file system. For example, if the source file system version of the snapshot is 1 and you need to create A file system of version 2, you can first create A file system A from the snapshot, then create A file system B that meets the configuration of version 2, copy the data in file system A to file system B, and migrate the business to file system B after the copy is completed.

status String

File system status. Includes:(such as creating a mount point) can only be performed when the file system is in the Running state.

storageType String

The storage type.

When FileSystemType = standard, the values are Performance, Capacity, and Premium.
When FileSystemType = extreme, the value is standard or advance.
When FileSystemType = cpfs, the values are advance_100(100MB/s/TiB baseline) and advance_200(200MB/s/TiB baseline).

tags Map<String>

Label information collection.

vpcId String

vswitchId String

zoneId String

The zone ID.

The usable area refers to the physical area where power and network are independent of each other in the same area.

NOTE: - file systems in different zones in the same region communicate with ECS cloud servers.

NOTE: - We recommend that the file system and the ECS instance belong to the same zone to avoid cross-zone latency.

Supporting Types

FileSystemNfsAcl, FileSystemNfsAclArgs

Enabled bool: Whether the NFS ACL function is enabled.

Enabled bool: Whether the NFS ACL function is enabled.

enabled Boolean: Whether the NFS ACL function is enabled.

enabled boolean: Whether the NFS ACL function is enabled.

enabled bool: Whether the NFS ACL function is enabled.

enabled Boolean: Whether the NFS ACL function is enabled.

FileSystemOptions, FileSystemOptionsArgs

EnableOplock bool

Whether to enable the OpLock function. Value:

true: On.
false: does not turn on.

NOTE: Description Only file systems of the SMB protocol type are supported.

EnableOplock bool

Whether to enable the OpLock function. Value:

true: On.
false: does not turn on.

NOTE: Description Only file systems of the SMB protocol type are supported.

enableOplock Boolean

Whether to enable the OpLock function. Value:

true: On.
false: does not turn on.

NOTE: Description Only file systems of the SMB protocol type are supported.

enableOplock boolean

Whether to enable the OpLock function. Value:

true: On.
false: does not turn on.

NOTE: Description Only file systems of the SMB protocol type are supported.

enable_oplock bool

Whether to enable the OpLock function. Value:

true: On.
false: does not turn on.

NOTE: Description Only file systems of the SMB protocol type are supported.

enableOplock Boolean

Whether to enable the OpLock function. Value:

true: On.
false: does not turn on.

NOTE: Description Only file systems of the SMB protocol type are supported.

FileSystemRecycleBin, FileSystemRecycleBinArgs

EnableTime string: Recycle Bin open time
ReservedDays int: Retention time of files in the Recycle Bin. Unit: days.
SecondarySize int: Amount of low-frequency data stored in the recycle bin. Unit: Byte.
Size int: The amount of files stored in the Recycle Bin. Unit: Byte.
Status string: Recycle Bin Status

EnableTime string: Recycle Bin open time
ReservedDays int: Retention time of files in the Recycle Bin. Unit: days.
SecondarySize int: Amount of low-frequency data stored in the recycle bin. Unit: Byte.
Size int: The amount of files stored in the Recycle Bin. Unit: Byte.
Status string: Recycle Bin Status

enableTime String: Recycle Bin open time
reservedDays Integer: Retention time of files in the Recycle Bin. Unit: days.
secondarySize Integer: Amount of low-frequency data stored in the recycle bin. Unit: Byte.
size Integer: The amount of files stored in the Recycle Bin. Unit: Byte.
status String: Recycle Bin Status

enableTime string: Recycle Bin open time
reservedDays number: Retention time of files in the Recycle Bin. Unit: days.
secondarySize number: Amount of low-frequency data stored in the recycle bin. Unit: Byte.
size number: The amount of files stored in the Recycle Bin. Unit: Byte.
status string: Recycle Bin Status

enable_time str: Recycle Bin open time
reserved_days int: Retention time of files in the Recycle Bin. Unit: days.
secondary_size int: Amount of low-frequency data stored in the recycle bin. Unit: Byte.
size int: The amount of files stored in the Recycle Bin. Unit: Byte.
status str: Recycle Bin Status

enableTime String: Recycle Bin open time
reservedDays Number: Retention time of files in the Recycle Bin. Unit: days.
secondarySize Number: Amount of low-frequency data stored in the recycle bin. Unit: Byte.
size Number: The amount of files stored in the Recycle Bin. Unit: Byte.
status String: Recycle Bin Status

FileSystemSmbAcl, FileSystemSmbAclArgs

EnableAnonymousAccess bool

Whether to allow anonymous access.

true: Allow anonymous access.
false (default): Anonymous access is not allowed.

Enabled bool

Whether SMB ACL is enabled

EncryptData bool

Whether transmission encryption is enabled.

true: Enables encryption in transit.
false (default): Transport encryption is not enabled.

HomeDirPath string

The user directory home path for each user. The file path format is as follows:

A forward slash (/) or backslash () as a separator.
Each paragraph cannot contain ":|? *.
The length of each segment ranges from 0 to 255.
The total length range is 0~32767.

For example, if the user directory is/home, the file system will automatically create A directory of/home/A when user A logs in. Skip if/home/A already exists.

NOTE: Explain that user A needs to have the permission to create A directory, otherwise the/home/A directory cannot be created.

RejectUnencryptedAccess bool

Whether to reject non-encrypted clients.

true: Deny non-encrypted clients.
false (default): Non-encrypted clients are not rejected.

SuperAdminSid string

The ID of the Super User. The ID rules are as follows:

Must start with S and no other letters can appear after the S at the beginning.
At least three dashes (-) apart.

Such as S-1-5-22 or S-1-5-22-23.

EnableAnonymousAccess bool

Whether to allow anonymous access.

true: Allow anonymous access.
false (default): Anonymous access is not allowed.

Enabled bool

Whether SMB ACL is enabled

EncryptData bool

Whether transmission encryption is enabled.

true: Enables encryption in transit.
false (default): Transport encryption is not enabled.

HomeDirPath string

The user directory home path for each user. The file path format is as follows:

A forward slash (/) or backslash () as a separator.
Each paragraph cannot contain ":|? *.
The length of each segment ranges from 0 to 255.
The total length range is 0~32767.

For example, if the user directory is/home, the file system will automatically create A directory of/home/A when user A logs in. Skip if/home/A already exists.

NOTE: Explain that user A needs to have the permission to create A directory, otherwise the/home/A directory cannot be created.

RejectUnencryptedAccess bool

Whether to reject non-encrypted clients.

true: Deny non-encrypted clients.
false (default): Non-encrypted clients are not rejected.

SuperAdminSid string

The ID of the Super User. The ID rules are as follows:

Must start with S and no other letters can appear after the S at the beginning.
At least three dashes (-) apart.

Such as S-1-5-22 or S-1-5-22-23.

enableAnonymousAccess Boolean

Whether to allow anonymous access.

true: Allow anonymous access.
false (default): Anonymous access is not allowed.

enabled Boolean

Whether SMB ACL is enabled

encryptData Boolean

Whether transmission encryption is enabled.

true: Enables encryption in transit.
false (default): Transport encryption is not enabled.

homeDirPath String

The user directory home path for each user. The file path format is as follows:

A forward slash (/) or backslash () as a separator.
Each paragraph cannot contain ":|? *.
The length of each segment ranges from 0 to 255.
The total length range is 0~32767.

For example, if the user directory is/home, the file system will automatically create A directory of/home/A when user A logs in. Skip if/home/A already exists.

NOTE: Explain that user A needs to have the permission to create A directory, otherwise the/home/A directory cannot be created.

rejectUnencryptedAccess Boolean

Whether to reject non-encrypted clients.

true: Deny non-encrypted clients.
false (default): Non-encrypted clients are not rejected.

superAdminSid String

The ID of the Super User. The ID rules are as follows:

Must start with S and no other letters can appear after the S at the beginning.
At least three dashes (-) apart.

Such as S-1-5-22 or S-1-5-22-23.

enableAnonymousAccess boolean

Whether to allow anonymous access.

true: Allow anonymous access.
false (default): Anonymous access is not allowed.

enabled boolean

Whether SMB ACL is enabled

encryptData boolean

Whether transmission encryption is enabled.

true: Enables encryption in transit.
false (default): Transport encryption is not enabled.

homeDirPath string

The user directory home path for each user. The file path format is as follows:

A forward slash (/) or backslash () as a separator.
Each paragraph cannot contain ":|? *.
The length of each segment ranges from 0 to 255.
The total length range is 0~32767.

For example, if the user directory is/home, the file system will automatically create A directory of/home/A when user A logs in. Skip if/home/A already exists.

NOTE: Explain that user A needs to have the permission to create A directory, otherwise the/home/A directory cannot be created.

rejectUnencryptedAccess boolean

Whether to reject non-encrypted clients.

true: Deny non-encrypted clients.
false (default): Non-encrypted clients are not rejected.

superAdminSid string

The ID of the Super User. The ID rules are as follows:

Must start with S and no other letters can appear after the S at the beginning.
At least three dashes (-) apart.

Such as S-1-5-22 or S-1-5-22-23.

enable_anonymous_access bool

Whether to allow anonymous access.

true: Allow anonymous access.
false (default): Anonymous access is not allowed.

enabled bool

Whether SMB ACL is enabled

encrypt_data bool

Whether transmission encryption is enabled.

true: Enables encryption in transit.
false (default): Transport encryption is not enabled.

home_dir_path str

The user directory home path for each user. The file path format is as follows:

A forward slash (/) or backslash () as a separator.
Each paragraph cannot contain ":|? *.
The length of each segment ranges from 0 to 255.
The total length range is 0~32767.

For example, if the user directory is/home, the file system will automatically create A directory of/home/A when user A logs in. Skip if/home/A already exists.

NOTE: Explain that user A needs to have the permission to create A directory, otherwise the/home/A directory cannot be created.

reject_unencrypted_access bool

Whether to reject non-encrypted clients.

true: Deny non-encrypted clients.
false (default): Non-encrypted clients are not rejected.

super_admin_sid str

The ID of the Super User. The ID rules are as follows:

Must start with S and no other letters can appear after the S at the beginning.
At least three dashes (-) apart.

Such as S-1-5-22 or S-1-5-22-23.

enableAnonymousAccess Boolean

Whether to allow anonymous access.

true: Allow anonymous access.
false (default): Anonymous access is not allowed.

enabled Boolean

Whether SMB ACL is enabled

encryptData Boolean

Whether transmission encryption is enabled.

true: Enables encryption in transit.
false (default): Transport encryption is not enabled.

homeDirPath String

The user directory home path for each user. The file path format is as follows:

A forward slash (/) or backslash () as a separator.
Each paragraph cannot contain ":|? *.
The length of each segment ranges from 0 to 255.
The total length range is 0~32767.

For example, if the user directory is/home, the file system will automatically create A directory of/home/A when user A logs in. Skip if/home/A already exists.

NOTE: Explain that user A needs to have the permission to create A directory, otherwise the/home/A directory cannot be created.

rejectUnencryptedAccess Boolean

Whether to reject non-encrypted clients.

true: Deny non-encrypted clients.
false (default): Non-encrypted clients are not rejected.

superAdminSid String

The ID of the Super User. The ID rules are as follows:

Must start with S and no other letters can appear after the S at the beginning.
At least three dashes (-) apart.

Such as S-1-5-22 or S-1-5-22-23.

Import

File Storage (NAS) File System can be imported using the id, e.g.

$ pulumi import alicloud:nas/fileSystem:FileSystem example <id>

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

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.nas.FileSystem

On this page

On this page

Example Usage

Create FileSystem Resource

Constructor syntax

Parameters

Constructor example

FileSystem Resource Properties

Inputs

Outputs

Look up Existing FileSystem Resource

Supporting Types

FileSystemNfsAcl, FileSystemNfsAclArgs

FileSystemOptions, FileSystemOptionsArgs

FileSystemRecycleBin, FileSystemRecycleBinArgs

FileSystemSmbAcl, FileSystemSmbAclArgs

Import

Package Details

On this page

On this page