ALIYUN::NAS::FileSystem is used to create a file system.
Syntax
{
"Type": "ALIYUN::NAS::FileSystem",
"Properties": {
"SnapshotId": String,
"Description": String,
"StorageType": String,
"DeletionForce": Boolean,
"EncryptType": Integer,
"VpcId": String,
"ZoneId": String,
"Capacity": Integer,
"Tags": List,
"ProtocolType": String,
"FileSystemType": String,
"Bandwidth": Integer,
"VSwitchId": String,
"Duration": Integer,
"ChargeType": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
ProtocolType | String | Yes | No | The protocol type. | Valid values:
|
StorageType | String | Yes | No | The storage type. | Valid values:
|
DeletionForce | Boolean | No | Yes | Specifies whether to forcefully delete the file system. | Default value: false. Valid values:
|
Description | String | No | Yes | The description of the file system. | The description must be 2 to 128 characters in length, and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The description must start with a letter but cannot start with http:// or https:// . |
ZoneId | String | No | No | The ID of the zone. | None. |
Tags | List | No | Yes | The tags of the file system. | You can add up to 20 tags to each file system. For more information, see Tags properties. |
SnapshotId | String | No | No | The ID of the snapshot. | You can configure this property to specify a snapshot from which you create an Apsara File Storage NAS (NAS) file system. This property is supported only for Extreme NAS file systems.
Note If you create a file system from a snapshot, the version of the new file system must be the same as the version of the source file system that is contained in the snapshot. If the version of a file system that you create is different from the version of the source file system, you must perform the following operations:
|
EncryptType | Integer | No | No | Specifies whether to encrypt the file system. You can use keys that are hosted by Key Management Service (KMS) to encrypt data that is stored in the file system. When you read and write the encrypted data, you do not need to decrypt the data. | This property takes effect when you set the FileSystemType property to standard or extreme. Valid values:
|
Capacity | Integer | No | No | The capacity of the file system. | This property takes effect and is required when you set the FileSystemType property to extreme or cpfs. Valid values:
Unit: GB. |
FileSystemType | String | No | No | The type of the file system. | Default value: standard. Valid values:
|
VpcId | String | No | No | The ID of the virtual private cloud (VPC). If you specify the VpcId and VSwitchId properties, a default mount target is preconfigured when the file system is created. | This property is required when you set the FileSystemType property to cpfs. |
Bandwidth | Integer | No | No | The maximum throughput of the file system. | This property is required when you set the FileSystemType property to cpfs. The value of this property varies based on the value of the Capacity property. For more information, visit the CPFS buy page. Unit: Mbit/s. |
VSwitchId | String | No | No | The ID of the vSwitch. If you specify the VpcId and VSwitchId properties, a default mount target is preconfigured when the file system is created. | This property is required when you set the FileSystemType property to cpfs. |
Duration | Integer | No | No | The subscription period of the file system. | This property takes effect and is required when you set the ChargeType property to Subscription. If you do not renew a subscription file system when it expires, the file system is automitically released. Valid values:
Unit: month. |
ChargeType | String | No | No | The billing method of the file system. | Valid values:
|
Tags syntax
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
Key | String | Yes | No | The key of the tag. | The key must be 1 to 128 characters in length, and cannot contain http:// or https:// . The key cannot start with aliyun or acs: . |
Value | String | No | No | The value of the tag. | The value must be 0 to 128 characters in length, and cannot contain http:// or https:// . The value cannot start with aliyun or acs: . |
Return values
Fn::GetAtt
FileSystemId: the ID of the file system.
Examples
JSON
format{ "ROSTemplateFormatVersion": "2015-09-01", "Description": "Test NAS FileSystem", "Parameters": { }, "Resources": { "FileSystem": { "Type": "ALIYUN::NAS::FileSystem", "Properties": { "ProtocolType": "NFS", "StorageType": "Capacity" } } }, "Outputs": { "FileSystemId": { "Description": "ID of the file system created", "Value": { "Fn::GetAtt": [ "FileSystem", "FileSystemId" ] } } } }
To view more examples, visit NAS.json and NAS.yml. In the examples, the following resource types are used: ALIYUN::NAS::FileSystem, ALIYUN::NAS::AccessGroup, ALIYUN::NAS::AccessRule, and ALIYUN::NAS::MountTarget.