Skip to content

FileSystemProps

Properties for defining a FileSystem.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-nas-filesystem

Initializer

using AlibabaCloud.SDK.ROS.CDK.Nas;
new FileSystemProps {
    object ProtocolType,
    object StorageType,
    object Bandwidth = null,
    object Capacity = null,
    object ChargeType = null,
    object DeletionForce = null,
    object Description = null,
    object Duration = null,
    object EncryptType = null,
    object FileSystemType = null,
    object ResourceGroupId = null,
    object SnapshotId = null,
    TagsProperty[] Tags = null,
    object VpcId = null,
    object VSwitchId = null,
    object ZoneId = null
};

Properties

Name Type Description
ProtocolType object Property protocolType: Type of protocol used.
StorageType object Property storageType: The storage type of the file System.
Bandwidth object Property bandwidth: Maximum file system throughput, unit is MB\/s.
Capacity object Property capacity: Specify the capacity of the file system.
ChargeType object Property chargeType: Type of payment: PayAsYouGo (pay as you go) Subscription.
DeletionForce object Property deletionForce: Whether delete all mount targets on the file system and then delete file system.
Description object Property description: The description of the file system.
Duration object Property duration: The period of subscription in months.
EncryptType object Property encryptType: Specifies whether to encrypt data in the file system.
FileSystemType object Property fileSystemType: File system type.
ResourceGroupId object Property resourceGroupId: Resource group id.
SnapshotId object Property snapshotId: The snapshot ID.
Tags TagsProperty[] Property tags: Tags to attach to filesystem.
VpcId object Property vpcId: The VPC ID.
VSwitchId object Property vSwitchId: The vSwitch ID.
ZoneId object Property zoneId: The ID of the zone.

ProtocolTypeRequired

public object ProtocolType { get; set; }
  • Type: object

Property protocolType: Type of protocol used.

Valid values: NFS, SMB, cpfs.


StorageTypeRequired

public object StorageType { get; set; }
  • Type: object

Property storageType: The storage type of the file System.

Valid values: Performance、Capacity、Premium(Available when the file_system_type is standard) standard、advance(Available when the file_system_type is extreme) advance_100、advance_200(Available when the file_system_type is cpfs)


BandwidthOptional

public object Bandwidth { get; set; }
  • Type: object

Property bandwidth: Maximum file system throughput, unit is MB\/s.

Required and valid only when FileSystemType=cpfs.


CapacityOptional

public object Capacity { get; set; }
  • Type: object

Property capacity: Specify the capacity of the file system.

Unit: GiB. This parameter is required and valid when FileSystemType is set to extreme, cpfs, or cpfsse. Specify a value based on the specifications on the following buy page:

  • Extreme NAS (Pay-as-you-go)
  • CPFS (Pay-as-you-go)

ChargeTypeOptional

public object ChargeType { get; set; }
  • Type: object

Property chargeType: Type of payment: PayAsYouGo (pay as you go) Subscription.


DeletionForceOptional

public object DeletionForce { get; set; }
  • Type: object

Property deletionForce: Whether delete all mount targets on the file system and then delete file system.

Default is false


DescriptionOptional

public object Description { get; set; }
  • Type: object

Property description: The description of the file system.

Limits:

  • Must be 2 to 128 characters in length.
  • Must start with a letter but cannot start with http:\/\/ or https:\/\/.
  • Can contain digits, colons (:), underscores (_), and hyphens (-).

DurationOptional

public object Duration { get; set; }
  • Type: object

Property duration: The period of subscription in months.

Required and valid when ChargeType is Subscription. When the annual and monthly subscription instance expires without renewal, the instance will automatically expire and be released.


EncryptTypeOptional

public object EncryptType { get; set; }
  • Type: object

Property encryptType: Specifies whether to encrypt data in the file system.

You can use the keys that are managed by Key Management Service (KMS) to encrypt data in a file system. When you read and write the encrypted data, the data is automatically decrypted. Valid values:

  • 0 (default): The data in the file system is not encrypted.
  • 1: A NAS-managed key is used to encrypt the data in the file system. This value is valid if FileSystemType is set to standard or extreme.
  • 2: A KMS-managed key is used to encrypt the data in the file system. This value is valid if the FileSystemType parameter is set to standard or extreme.
  • Extreme NAS: All regions except China East 1 Finance support KMS-managed keys.
  • General-purpose NAS: All regions support KMS-managed keys.

FileSystemTypeOptional

public object FileSystemType { get; set; }
  • Type: object

Property fileSystemType: File system type.

Allowed values: standard(default), extreme, cpfs


ResourceGroupIdOptional

public object ResourceGroupId { get; set; }
  • Type: object

Property resourceGroupId: Resource group id.


SnapshotIdOptional

public object SnapshotId { get; set; }
  • Type: object

Property snapshotId: The snapshot ID.

This parameter is available only for advanced Extreme NAS file systems.

You can create a file system from a snapshot. The version of the file system is the same as that of the source file system. For example, the source file system of the snapshot uses version 1. To create a file system of version 2, create File System A from the snapshot and create File System B of version 2. Then copy the data and migrate your business from File System A to File System B.


TagsOptional

public TagsProperty[] Tags { get; set; }

Property tags: Tags to attach to filesystem.

Max support 20 tags to add during create filesystem. Each tag with two properties Key and Value, and Key is required.


VpcIdOptional

public object VpcId { get; set; }
  • Type: object

Property vpcId: The VPC ID.

  • This parameter is required if FileSystemType is set to cpfs or cpfsse.
  • This parameter is reserved and not required if FileSystemType is set to standard or extreme.

VSwitchIdOptional

public object VSwitchId { get; set; }
  • Type: object

Property vSwitchId: The vSwitch ID.

  • This parameter is required if FileSystemType is set to cpfs.
  • If FileSystemType is not set to cpfs, this parameter is reserved and not required.

ZoneIdOptional

public object ZoneId { get; set; }
  • Type: object

Property zoneId: The ID of the zone.

Each region has multiple isolated locations known as zones. Each zone has its own independent power supply and network. This parameter is not required if FileSystemType is set to standard. By default, a random zone is selected based on the protocol type and storage type. This parameter is required if FileSystemType is set to extreme or cpfs.

  • An Elastic Compute Service (ECS) instance and a file system that reside in different zones of the same region can access each other.
  • We recommend that you select the zone where the ECS instance resides. This prevents cross-zone latency between the file system and the ECS instance.