Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. cloudfs
  5. FileSystem
Volcengine v0.0.28 published on Thursday, Apr 24, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.cloudfs.FileSystem

Explore with Pulumi AI

Volcengine v0.0.28 published on Thursday, Apr 24, 2025 by Volcengine
volcengine/pulumi-volcengine

Provides a resource to manage cloudfs file system

Example Usage

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

const foo = new volcengine.cloudfs.FileSystem("foo", {
    cacheCapacityTib: 10,
    cachePlan: "T2",
    fsName: "tffile",
    mode: "HDFS_MODE",
    readOnly: true,
    securityGroupId: "sg-rrv1klfg5s00v0x578mx14m",
    subnetId: "subnet-13fca1crr5d6o3n6nu46cyb5m",
    tosBucket: "tfacc",
    tosPrefix: "pre/",
    vpcRouteEnabled: true,
    zoneId: "cn-beijing-b",
});
const foo1 = new volcengine.cloudfs.FileSystem("foo1", {
    cacheCapacityTib: 15,
    cachePlan: "T2",
    fsName: "tffileu",
    mode: "ACC_MODE",
    readOnly: true,
    securityGroupId: "sg-rrv1klfg5s00v0x578mx14m",
    subnetId: "subnet-13fca1crr5d6o3n6nu46cyb5m",
    tosBucket: "tfacc",
    vpcRouteEnabled: false,
    zoneId: "cn-beijing-b",
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.cloudfs.FileSystem("foo",
    cache_capacity_tib=10,
    cache_plan="T2",
    fs_name="tffile",
    mode="HDFS_MODE",
    read_only=True,
    security_group_id="sg-rrv1klfg5s00v0x578mx14m",
    subnet_id="subnet-13fca1crr5d6o3n6nu46cyb5m",
    tos_bucket="tfacc",
    tos_prefix="pre/",
    vpc_route_enabled=True,
    zone_id="cn-beijing-b")
foo1 = volcengine.cloudfs.FileSystem("foo1",
    cache_capacity_tib=15,
    cache_plan="T2",
    fs_name="tffileu",
    mode="ACC_MODE",
    read_only=True,
    security_group_id="sg-rrv1klfg5s00v0x578mx14m",
    subnet_id="subnet-13fca1crr5d6o3n6nu46cyb5m",
    tos_bucket="tfacc",
    vpc_route_enabled=False,
    zone_id="cn-beijing-b")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/cloudfs"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfs.NewFileSystem(ctx, "foo", &cloudfs.FileSystemArgs{
			CacheCapacityTib: pulumi.Int(10),
			CachePlan:        pulumi.String("T2"),
			FsName:           pulumi.String("tffile"),
			Mode:             pulumi.String("HDFS_MODE"),
			ReadOnly:         pulumi.Bool(true),
			SecurityGroupId:  pulumi.String("sg-rrv1klfg5s00v0x578mx14m"),
			SubnetId:         pulumi.String("subnet-13fca1crr5d6o3n6nu46cyb5m"),
			TosBucket:        pulumi.String("tfacc"),
			TosPrefix:        pulumi.String("pre/"),
			VpcRouteEnabled:  pulumi.Bool(true),
			ZoneId:           pulumi.String("cn-beijing-b"),
		})
		if err != nil {
			return err
		}
		_, err = cloudfs.NewFileSystem(ctx, "foo1", &cloudfs.FileSystemArgs{
			CacheCapacityTib: pulumi.Int(15),
			CachePlan:        pulumi.String("T2"),
			FsName:           pulumi.String("tffileu"),
			Mode:             pulumi.String("ACC_MODE"),
			ReadOnly:         pulumi.Bool(true),
			SecurityGroupId:  pulumi.String("sg-rrv1klfg5s00v0x578mx14m"),
			SubnetId:         pulumi.String("subnet-13fca1crr5d6o3n6nu46cyb5m"),
			TosBucket:        pulumi.String("tfacc"),
			VpcRouteEnabled:  pulumi.Bool(false),
			ZoneId:           pulumi.String("cn-beijing-b"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Cloudfs.FileSystem("foo", new()
    {
        CacheCapacityTib = 10,
        CachePlan = "T2",
        FsName = "tffile",
        Mode = "HDFS_MODE",
        ReadOnly = true,
        SecurityGroupId = "sg-rrv1klfg5s00v0x578mx14m",
        SubnetId = "subnet-13fca1crr5d6o3n6nu46cyb5m",
        TosBucket = "tfacc",
        TosPrefix = "pre/",
        VpcRouteEnabled = true,
        ZoneId = "cn-beijing-b",
    });

    var foo1 = new Volcengine.Cloudfs.FileSystem("foo1", new()
    {
        CacheCapacityTib = 15,
        CachePlan = "T2",
        FsName = "tffileu",
        Mode = "ACC_MODE",
        ReadOnly = true,
        SecurityGroupId = "sg-rrv1klfg5s00v0x578mx14m",
        SubnetId = "subnet-13fca1crr5d6o3n6nu46cyb5m",
        TosBucket = "tfacc",
        VpcRouteEnabled = false,
        ZoneId = "cn-beijing-b",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.cloudfs.FileSystem;
import com.pulumi.volcengine.cloudfs.FileSystemArgs;
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 foo = new FileSystem("foo", FileSystemArgs.builder()        
            .cacheCapacityTib(10)
            .cachePlan("T2")
            .fsName("tffile")
            .mode("HDFS_MODE")
            .readOnly(true)
            .securityGroupId("sg-rrv1klfg5s00v0x578mx14m")
            .subnetId("subnet-13fca1crr5d6o3n6nu46cyb5m")
            .tosBucket("tfacc")
            .tosPrefix("pre/")
            .vpcRouteEnabled(true)
            .zoneId("cn-beijing-b")
            .build());

        var foo1 = new FileSystem("foo1", FileSystemArgs.builder()        
            .cacheCapacityTib(15)
            .cachePlan("T2")
            .fsName("tffileu")
            .mode("ACC_MODE")
            .readOnly(true)
            .securityGroupId("sg-rrv1klfg5s00v0x578mx14m")
            .subnetId("subnet-13fca1crr5d6o3n6nu46cyb5m")
            .tosBucket("tfacc")
            .vpcRouteEnabled(false)
            .zoneId("cn-beijing-b")
            .build());

    }
}
Copy
resources:
  foo:
    type: volcengine:cloudfs:FileSystem
    properties:
      cacheCapacityTib: 10
      cachePlan: T2
      fsName: tffile
      mode: HDFS_MODE
      readOnly: true
      securityGroupId: sg-rrv1klfg5s00v0x578mx14m
      subnetId: subnet-13fca1crr5d6o3n6nu46cyb5m
      tosBucket: tfacc
      tosPrefix: pre/
      vpcRouteEnabled: true
      zoneId: cn-beijing-b
  foo1:
    type: volcengine:cloudfs:FileSystem
    properties:
      cacheCapacityTib: 15
      cachePlan: T2
      fsName: tffileu
      mode: ACC_MODE
      readOnly: true
      securityGroupId: sg-rrv1klfg5s00v0x578mx14m
      subnetId: subnet-13fca1crr5d6o3n6nu46cyb5m
      tosBucket: tfacc
      vpcRouteEnabled: false
      zoneId: cn-beijing-b
Copy

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,
               zone_id: Optional[str] = None,
               cache_plan: Optional[str] = None,
               fs_name: Optional[str] = None,
               mode: Optional[str] = None,
               subnet_id: Optional[str] = None,
               security_group_id: Optional[str] = None,
               cache_capacity_tib: Optional[int] = None,
               tos_account_id: Optional[int] = None,
               tos_ak: Optional[str] = None,
               tos_bucket: Optional[str] = None,
               tos_prefix: Optional[str] = None,
               tos_sk: Optional[str] = None,
               vpc_route_enabled: Optional[bool] = None,
               read_only: Optional[bool] = 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: volcengine:cloudfs:FileSystem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FileSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. FileSystemArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FileSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 fileSystemResource = new Volcengine.Cloudfs.FileSystem("fileSystemResource", new()
{
    ZoneId = "string",
    CachePlan = "string",
    FsName = "string",
    Mode = "string",
    SubnetId = "string",
    SecurityGroupId = "string",
    CacheCapacityTib = 0,
    TosAccountId = 0,
    TosAk = "string",
    TosBucket = "string",
    TosPrefix = "string",
    TosSk = "string",
    VpcRouteEnabled = false,
    ReadOnly = false,
});
Copy
example, err := cloudfs.NewFileSystem(ctx, "fileSystemResource", &cloudfs.FileSystemArgs{
	ZoneId:           pulumi.String("string"),
	CachePlan:        pulumi.String("string"),
	FsName:           pulumi.String("string"),
	Mode:             pulumi.String("string"),
	SubnetId:         pulumi.String("string"),
	SecurityGroupId:  pulumi.String("string"),
	CacheCapacityTib: pulumi.Int(0),
	TosAccountId:     pulumi.Int(0),
	TosAk:            pulumi.String("string"),
	TosBucket:        pulumi.String("string"),
	TosPrefix:        pulumi.String("string"),
	TosSk:            pulumi.String("string"),
	VpcRouteEnabled:  pulumi.Bool(false),
	ReadOnly:         pulumi.Bool(false),
})
Copy
var fileSystemResource = new com.pulumi.volcengine.cloudfs.FileSystem("fileSystemResource", com.pulumi.volcengine.cloudfs.FileSystemArgs.builder()
    .zoneId("string")
    .cachePlan("string")
    .fsName("string")
    .mode("string")
    .subnetId("string")
    .securityGroupId("string")
    .cacheCapacityTib(0)
    .tosAccountId(0)
    .tosAk("string")
    .tosBucket("string")
    .tosPrefix("string")
    .tosSk("string")
    .vpcRouteEnabled(false)
    .readOnly(false)
    .build());
Copy
file_system_resource = volcengine.cloudfs.FileSystem("fileSystemResource",
    zone_id="string",
    cache_plan="string",
    fs_name="string",
    mode="string",
    subnet_id="string",
    security_group_id="string",
    cache_capacity_tib=0,
    tos_account_id=0,
    tos_ak="string",
    tos_bucket="string",
    tos_prefix="string",
    tos_sk="string",
    vpc_route_enabled=False,
    read_only=False)
Copy
const fileSystemResource = new volcengine.cloudfs.FileSystem("fileSystemResource", {
    zoneId: "string",
    cachePlan: "string",
    fsName: "string",
    mode: "string",
    subnetId: "string",
    securityGroupId: "string",
    cacheCapacityTib: 0,
    tosAccountId: 0,
    tosAk: "string",
    tosBucket: "string",
    tosPrefix: "string",
    tosSk: "string",
    vpcRouteEnabled: false,
    readOnly: false,
});
Copy
type: volcengine:cloudfs:FileSystem
properties:
    cacheCapacityTib: 0
    cachePlan: string
    fsName: string
    mode: string
    readOnly: false
    securityGroupId: string
    subnetId: string
    tosAccountId: 0
    tosAk: string
    tosBucket: string
    tosPrefix: string
    tosSk: string
    vpcRouteEnabled: false
    zoneId: string
Copy

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:

CachePlan This property is required. string
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
FsName
This property is required.
Changes to this property will trigger replacement.
string
The name of file system.
Mode
This property is required.
Changes to this property will trigger replacement.
string
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
ZoneId
This property is required.
Changes to this property will trigger replacement.
string
The id of zone.
CacheCapacityTib int
The capacity of cache. This parameter is required when cache acceleration is enabled.
ReadOnly Changes to this property will trigger replacement. bool
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
SecurityGroupId string
The id of security group. This parameter is required when cache acceleration is enabled.
SubnetId string
The id of subnet. This parameter is required when cache acceleration is enabled.
TosAccountId Changes to this property will trigger replacement. int
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
TosAk Changes to this property will trigger replacement. string
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
TosBucket Changes to this property will trigger replacement. string
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
TosPrefix Changes to this property will trigger replacement. string
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
TosSk Changes to this property will trigger replacement. string
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
VpcRouteEnabled bool
Whether enable all vpc route.
CachePlan This property is required. string
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
FsName
This property is required.
Changes to this property will trigger replacement.
string
The name of file system.
Mode
This property is required.
Changes to this property will trigger replacement.
string
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
ZoneId
This property is required.
Changes to this property will trigger replacement.
string
The id of zone.
CacheCapacityTib int
The capacity of cache. This parameter is required when cache acceleration is enabled.
ReadOnly Changes to this property will trigger replacement. bool
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
SecurityGroupId string
The id of security group. This parameter is required when cache acceleration is enabled.
SubnetId string
The id of subnet. This parameter is required when cache acceleration is enabled.
TosAccountId Changes to this property will trigger replacement. int
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
TosAk Changes to this property will trigger replacement. string
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
TosBucket Changes to this property will trigger replacement. string
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
TosPrefix Changes to this property will trigger replacement. string
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
TosSk Changes to this property will trigger replacement. string
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
VpcRouteEnabled bool
Whether enable all vpc route.
cachePlan This property is required. String
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
fsName
This property is required.
Changes to this property will trigger replacement.
String
The name of file system.
mode
This property is required.
Changes to this property will trigger replacement.
String
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
zoneId
This property is required.
Changes to this property will trigger replacement.
String
The id of zone.
cacheCapacityTib Integer
The capacity of cache. This parameter is required when cache acceleration is enabled.
readOnly Changes to this property will trigger replacement. Boolean
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
securityGroupId String
The id of security group. This parameter is required when cache acceleration is enabled.
subnetId String
The id of subnet. This parameter is required when cache acceleration is enabled.
tosAccountId Changes to this property will trigger replacement. Integer
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
tosAk Changes to this property will trigger replacement. String
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
tosBucket Changes to this property will trigger replacement. String
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
tosPrefix Changes to this property will trigger replacement. String
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
tosSk Changes to this property will trigger replacement. String
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
vpcRouteEnabled Boolean
Whether enable all vpc route.
cachePlan This property is required. string
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
fsName
This property is required.
Changes to this property will trigger replacement.
string
The name of file system.
mode
This property is required.
Changes to this property will trigger replacement.
string
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
zoneId
This property is required.
Changes to this property will trigger replacement.
string
The id of zone.
cacheCapacityTib number
The capacity of cache. This parameter is required when cache acceleration is enabled.
readOnly Changes to this property will trigger replacement. boolean
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
securityGroupId string
The id of security group. This parameter is required when cache acceleration is enabled.
subnetId string
The id of subnet. This parameter is required when cache acceleration is enabled.
tosAccountId Changes to this property will trigger replacement. number
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
tosAk Changes to this property will trigger replacement. string
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
tosBucket Changes to this property will trigger replacement. string
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
tosPrefix Changes to this property will trigger replacement. string
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
tosSk Changes to this property will trigger replacement. string
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
vpcRouteEnabled boolean
Whether enable all vpc route.
cache_plan This property is required. str
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
fs_name
This property is required.
Changes to this property will trigger replacement.
str
The name of file system.
mode
This property is required.
Changes to this property will trigger replacement.
str
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
zone_id
This property is required.
Changes to this property will trigger replacement.
str
The id of zone.
cache_capacity_tib int
The capacity of cache. This parameter is required when cache acceleration is enabled.
read_only Changes to this property will trigger replacement. bool
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
security_group_id str
The id of security group. This parameter is required when cache acceleration is enabled.
subnet_id str
The id of subnet. This parameter is required when cache acceleration is enabled.
tos_account_id Changes to this property will trigger replacement. int
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
tos_ak Changes to this property will trigger replacement. str
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
tos_bucket Changes to this property will trigger replacement. str
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
tos_prefix Changes to this property will trigger replacement. str
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
tos_sk Changes to this property will trigger replacement. str
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
vpc_route_enabled bool
Whether enable all vpc route.
cachePlan This property is required. String
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
fsName
This property is required.
Changes to this property will trigger replacement.
String
The name of file system.
mode
This property is required.
Changes to this property will trigger replacement.
String
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
zoneId
This property is required.
Changes to this property will trigger replacement.
String
The id of zone.
cacheCapacityTib Number
The capacity of cache. This parameter is required when cache acceleration is enabled.
readOnly Changes to this property will trigger replacement. Boolean
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
securityGroupId String
The id of security group. This parameter is required when cache acceleration is enabled.
subnetId String
The id of subnet. This parameter is required when cache acceleration is enabled.
tosAccountId Changes to this property will trigger replacement. Number
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
tosAk Changes to this property will trigger replacement. String
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
tosBucket Changes to this property will trigger replacement. String
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
tosPrefix Changes to this property will trigger replacement. String
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
tosSk Changes to this property will trigger replacement. String
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
vpcRouteEnabled Boolean
Whether enable all vpc route.

Outputs

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

AccessId string
The default vpc access id.
CreatedTime string
The creation time.
Id string
The provider-assigned unique ID for this managed resource.
MountPoint string
The point mount.
Status string
Status of file system.
VpcId string
The id of vpc.
AccessId string
The default vpc access id.
CreatedTime string
The creation time.
Id string
The provider-assigned unique ID for this managed resource.
MountPoint string
The point mount.
Status string
Status of file system.
VpcId string
The id of vpc.
accessId String
The default vpc access id.
createdTime String
The creation time.
id String
The provider-assigned unique ID for this managed resource.
mountPoint String
The point mount.
status String
Status of file system.
vpcId String
The id of vpc.
accessId string
The default vpc access id.
createdTime string
The creation time.
id string
The provider-assigned unique ID for this managed resource.
mountPoint string
The point mount.
status string
Status of file system.
vpcId string
The id of vpc.
access_id str
The default vpc access id.
created_time str
The creation time.
id str
The provider-assigned unique ID for this managed resource.
mount_point str
The point mount.
status str
Status of file system.
vpc_id str
The id of vpc.
accessId String
The default vpc access id.
createdTime String
The creation time.
id String
The provider-assigned unique ID for this managed resource.
mountPoint String
The point mount.
status String
Status of file system.
vpcId String
The id of vpc.

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,
        access_id: Optional[str] = None,
        cache_capacity_tib: Optional[int] = None,
        cache_plan: Optional[str] = None,
        created_time: Optional[str] = None,
        fs_name: Optional[str] = None,
        mode: Optional[str] = None,
        mount_point: Optional[str] = None,
        read_only: Optional[bool] = None,
        security_group_id: Optional[str] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tos_account_id: Optional[int] = None,
        tos_ak: Optional[str] = None,
        tos_bucket: Optional[str] = None,
        tos_prefix: Optional[str] = None,
        tos_sk: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_route_enabled: Optional[bool] = 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: volcengine:cloudfs:FileSystem    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccessId string
The default vpc access id.
CacheCapacityTib int
The capacity of cache. This parameter is required when cache acceleration is enabled.
CachePlan string
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
CreatedTime string
The creation time.
FsName Changes to this property will trigger replacement. string
The name of file system.
Mode Changes to this property will trigger replacement. string
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
MountPoint string
The point mount.
ReadOnly Changes to this property will trigger replacement. bool
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
SecurityGroupId string
The id of security group. This parameter is required when cache acceleration is enabled.
Status string
Status of file system.
SubnetId string
The id of subnet. This parameter is required when cache acceleration is enabled.
TosAccountId Changes to this property will trigger replacement. int
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
TosAk Changes to this property will trigger replacement. string
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
TosBucket Changes to this property will trigger replacement. string
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
TosPrefix Changes to this property will trigger replacement. string
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
TosSk Changes to this property will trigger replacement. string
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
VpcId string
The id of vpc.
VpcRouteEnabled bool
Whether enable all vpc route.
ZoneId Changes to this property will trigger replacement. string
The id of zone.
AccessId string
The default vpc access id.
CacheCapacityTib int
The capacity of cache. This parameter is required when cache acceleration is enabled.
CachePlan string
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
CreatedTime string
The creation time.
FsName Changes to this property will trigger replacement. string
The name of file system.
Mode Changes to this property will trigger replacement. string
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
MountPoint string
The point mount.
ReadOnly Changes to this property will trigger replacement. bool
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
SecurityGroupId string
The id of security group. This parameter is required when cache acceleration is enabled.
Status string
Status of file system.
SubnetId string
The id of subnet. This parameter is required when cache acceleration is enabled.
TosAccountId Changes to this property will trigger replacement. int
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
TosAk Changes to this property will trigger replacement. string
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
TosBucket Changes to this property will trigger replacement. string
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
TosPrefix Changes to this property will trigger replacement. string
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
TosSk Changes to this property will trigger replacement. string
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
VpcId string
The id of vpc.
VpcRouteEnabled bool
Whether enable all vpc route.
ZoneId Changes to this property will trigger replacement. string
The id of zone.
accessId String
The default vpc access id.
cacheCapacityTib Integer
The capacity of cache. This parameter is required when cache acceleration is enabled.
cachePlan String
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
createdTime String
The creation time.
fsName Changes to this property will trigger replacement. String
The name of file system.
mode Changes to this property will trigger replacement. String
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
mountPoint String
The point mount.
readOnly Changes to this property will trigger replacement. Boolean
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
securityGroupId String
The id of security group. This parameter is required when cache acceleration is enabled.
status String
Status of file system.
subnetId String
The id of subnet. This parameter is required when cache acceleration is enabled.
tosAccountId Changes to this property will trigger replacement. Integer
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
tosAk Changes to this property will trigger replacement. String
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
tosBucket Changes to this property will trigger replacement. String
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
tosPrefix Changes to this property will trigger replacement. String
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
tosSk Changes to this property will trigger replacement. String
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
vpcId String
The id of vpc.
vpcRouteEnabled Boolean
Whether enable all vpc route.
zoneId Changes to this property will trigger replacement. String
The id of zone.
accessId string
The default vpc access id.
cacheCapacityTib number
The capacity of cache. This parameter is required when cache acceleration is enabled.
cachePlan string
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
createdTime string
The creation time.
fsName Changes to this property will trigger replacement. string
The name of file system.
mode Changes to this property will trigger replacement. string
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
mountPoint string
The point mount.
readOnly Changes to this property will trigger replacement. boolean
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
securityGroupId string
The id of security group. This parameter is required when cache acceleration is enabled.
status string
Status of file system.
subnetId string
The id of subnet. This parameter is required when cache acceleration is enabled.
tosAccountId Changes to this property will trigger replacement. number
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
tosAk Changes to this property will trigger replacement. string
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
tosBucket Changes to this property will trigger replacement. string
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
tosPrefix Changes to this property will trigger replacement. string
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
tosSk Changes to this property will trigger replacement. string
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
vpcId string
The id of vpc.
vpcRouteEnabled boolean
Whether enable all vpc route.
zoneId Changes to this property will trigger replacement. string
The id of zone.
access_id str
The default vpc access id.
cache_capacity_tib int
The capacity of cache. This parameter is required when cache acceleration is enabled.
cache_plan str
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
created_time str
The creation time.
fs_name Changes to this property will trigger replacement. str
The name of file system.
mode Changes to this property will trigger replacement. str
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
mount_point str
The point mount.
read_only Changes to this property will trigger replacement. bool
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
security_group_id str
The id of security group. This parameter is required when cache acceleration is enabled.
status str
Status of file system.
subnet_id str
The id of subnet. This parameter is required when cache acceleration is enabled.
tos_account_id Changes to this property will trigger replacement. int
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
tos_ak Changes to this property will trigger replacement. str
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
tos_bucket Changes to this property will trigger replacement. str
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
tos_prefix Changes to this property will trigger replacement. str
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
tos_sk Changes to this property will trigger replacement. str
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
vpc_id str
The id of vpc.
vpc_route_enabled bool
Whether enable all vpc route.
zone_id Changes to this property will trigger replacement. str
The id of zone.
accessId String
The default vpc access id.
cacheCapacityTib Number
The capacity of cache. This parameter is required when cache acceleration is enabled.
cachePlan String
The cache plan. The value can be DISABLED or T2 or T4. When expanding the cache size, the cache plan should remain the same. For data lakes, cache must be enabled.
createdTime String
The creation time.
fsName Changes to this property will trigger replacement. String
The name of file system.
mode Changes to this property will trigger replacement. String
The mode of file system. The value can be HDFS_MODE or ACC_MODE.
mountPoint String
The point mount.
readOnly Changes to this property will trigger replacement. Boolean
Whether the Namespace created automatically when mounting the TOS Bucket is read-only. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
securityGroupId String
The id of security group. This parameter is required when cache acceleration is enabled.
status String
Status of file system.
subnetId String
The id of subnet. This parameter is required when cache acceleration is enabled.
tosAccountId Changes to this property will trigger replacement. Number
When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported.
tosAk Changes to this property will trigger replacement. String
The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported.
tosBucket Changes to this property will trigger replacement. String
The tos bucket. When importing ACC_MODE resources, this attribute will not be imported.
tosPrefix Changes to this property will trigger replacement. String
The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path. When importing ACC_MODE resources, this attribute will not be imported.
tosSk Changes to this property will trigger replacement. String
The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported.
vpcId String
The id of vpc.
vpcRouteEnabled Boolean
Whether enable all vpc route.
zoneId Changes to this property will trigger replacement. String
The id of zone.

Import

CloudFileSystem can be imported using the FsName, e.g.

$ pulumi import volcengine:cloudfs/fileSystem:FileSystem default tfname
Copy

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

Package Details

Repository
volcengine volcengine/pulumi-volcengine
License
Apache-2.0
Notes
This Pulumi package is based on the volcengine Terraform Provider.
Volcengine v0.0.28 published on Thursday, Apr 24, 2025 by Volcengine
volcengine/pulumi-volcengine