ALIYUN::DFS::FileSystem is used to create a file system.

Syntax

{
  "Type": "ALIYUN::DFS::FileSystem",
  "Properties": {
    "SpaceCapacity": Integer,
    "Description": String,
    "StorageType": String,
    "ZoneId": String,
    "PartitionNumber": Integer,
    "ProtocolType": String,
    "DataRedundancyType": String,
    "FileSystemName": String,
    "ProvisionedThroughputInMiBps": Integer,
    "ThroughputMode": String,
    "StorageSetName": String
  }
}

Properties

Property Type Required Editable Description Constraint
SpaceCapacity Integer Yes Yes The estimated capacity of the file system. None.
Description String No Yes The description of the file system. None.
StorageType String Yes No The type of the storage medium. Valid values:
  • STANDARD
  • PERFORMANCE
ZoneId String Yes No The ID of the zone. None.
PartitionNumber Integer No No This property is reserved. None.
ProtocolType String Yes No The type of the protocol. Set the value to HDFS.
DataRedundancyType String No No The redundancy mode of the file system. Default value: LRS. Valid values:
  • LRS: locally redundant storage (LRS)
  • ZRS: zone-redundant storage (ZRS)

    If you set this property to ZRS, the value of the ZoneId property must be a string that consists of multiple zone IDs. Example: zoneId1,zoneId2.

FileSystemName String No Yes The name of the file system. The name must meet the following requirements:
  • The name must be 6 to 100 characters in length.
  • The name must be globally unique and cannot be an empty string.
  • The name can contain letters, digits, and underscores (_).
ProvisionedThroughputInMiBps Integer No Yes The provisioned throughput. Unit: MB/s.

Valid values: 1 to 5120.

ThroughputMode String No Yes The throughput mode. Default value: Standard. Valid values:
  • Standard: standard throughput
  • Provisioned: provisioned throughput
StorageSetName String No No This property is reserved. None.

Return values

Fn::GetAtt

FileSystemId: the ID of the file system.

Examples

  • JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SpaceCapacity": {
      "Type": "Number",
      "Description": "Capacity of the file system.\nWhen the actual data volume reaches the file system capacity, data cannot be written.\nUnit: GB"
    },
    "StorageType": {
      "Type": "String",
      "Description": "Type of storage media.\nValues:\nSTANDARD (default) : standard type.\nPERFORMANCE: performance type.",
      "AllowedValues": [
        "STANDARD",
        "PERFORMANCE"
      ],
      "Default": "STANDARD"
    },
    "ZoneId": {
      "Type": "String",
      "Description": "zone id"
    },
    "ProtocolType": {
      "Type": "String",
      "Description": The protocol type. Only Hadoop Distributed File System (HDFS) is supported",
      "AllowedValues": [
        "HDFS"
      ]
    }
  },
  "Resources": {
    "FileSystem": {
      "Type": "ALIYUN::DFS::FileSystem",
      "Properties": {
        "SpaceCapacity": {
          "Ref": "SpaceCapacity"
        },
        "StorageType": {
          "Ref": "StorageType"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "ProtocolType": {
          "Ref": "ProtocolType"
        }
      }
    }
  },
  "Outputs": {
    "FileSystemId": {
      "Description": "The ID of the file system.",
      "Value": {
        "Fn::GetAtt": [
          "FileSystem",
          "FileSystemId"
        ]
      }
    }
  }
}

  • YAML format 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SpaceCapacity:
    Type: Number
    Description: |-
      Capacity of the file system.
      When the actual data volume reaches the file system capacity, data cannot be written.
      Unit: GB
  StorageType:
    Type: String
    Description: |-
      Type of storage media.
      Values:
      STANDARD (default) : standard type.
      PERFORMANCE: performance type.
    AllowedValues:
      - STANDARD
      - PERFORMANCE
    Default: STANDARD
  ZoneId:
    Type: String
    Description: zone id
  ProtocolType:
    Type: String
    Description: The protocol type. Only HDFS is supported.
    AllowedValues:
      - HDFS
Resources:
  FileSystem:
    Type: ALIYUN::DFS::FileSystem
    Properties:
      SpaceCapacity:
        Ref: SpaceCapacity
      StorageType:
        Ref: StorageType
      ZoneId:
        Ref: ZoneId
      ProtocolType:
        Ref: ProtocolType
Outputs:
  FileSystemId:
    Description: The ID of the file system.
    Value:
      Fn::GetAtt:
        - FileSystem
        - FileSystemId