Use DATASOURCE::NAS::FileSystems in a call to query information about file systems - Resource Orchestration Service

DATASOURCE::NAS::FileSystems is used to query the information about file systems.

Syntax

{
  "Type": "DATASOURCE::NAS::FileSystems",
  "Properties": {
    "FileSystemType": String,
    "FileSystemId": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
FileSystemType	String	No	Yes	The type of the file system.	Valid values: all (default): all types of file systems standard: General-purpose File Storage NAS (NAS) file system extreme: Extreme NAS file system cpfs: Cloud Parallel File Storage (CPFS) file system
FileSystemId	String	No	Yes	The ID of the file system.	None.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

FileSystemIds: the IDs of the file systems.
FileSystems: details of the file systems.

Property	Type	Description	Constraint
FileSystemIds	List	The IDs of the file systems.	None.
FileSystems	List	Details of the file systems.	None.
Status	String	The status of the file system.	Valid values: Pending: The task of the file system is being processed. Running: The file system is running. Note You can perform subsequent operations, such as creating a mount target, on a file system only when the file system is in the Running state. Stopped: The file system is unavailable. Extending: The file system is being scaled up. Stopping: The file system is being stopped. Deleting: The file system is being deleted.
MeteredIASize	String	The storage usage of the Infrequent Access (IA) storage class.	Unit: bytes.
Capacity	String	The capacity of the file system.	Unit: GiB.
CreateTime	String	The time when the file system was created.	Example: 2017-05-27T15:43:06CST.
ChargeType	String	The billing method.	Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go Package: storage plan
Tags	List	The tags of the file system.	None.
StorageType	String	The storage type.	Valid values when FileSystemType is set to standard: Capacity Performance Valid values when FileSystemType is set to extreme: standard advance Valid values when FileSystemType is set to cpfs: advance_100: 100 MB/s/TiB baseline advance_200: 200 MB/s/TiB baseline
MeteredSize	String	The maximum storage usage of the file system within the previous hour.	Unit: bytes.
Description	String	The description of the file system.	None.
Bandwidth	String	The bandwidth of the file system.	Unit: MB/s. This property is returned if FileSystemType is set to all, extreme, or cpfs.
SupportedFeatures	List	The features that are supported by the file system.	Valid values: Lifecycle: lifecycle management ACL: access control list (ACL) Ipv6: IPv6 Note The IPv6 feature is supported when FileSystemType is set to extreme.
Version	String	The version of the file system.	This property is returned if FileSystemType is set to extreme.
ProtocolType	String	The protocol type of the file system.	Valid values: NFS SMB cpfs
MountTargets	List	The information about the mount targets.	None.
KMSKeyId	String	The ID of the key that is managed by Key Management Service (KMS).	None.
FileSystemType	String	The type of the file system.	Valid values: standard: General-purpose NAS file system extreme: Extreme NAS file system cpfs: CPFS file system
FileSystemId	String	The ID of the file system.	None.
EncryptType	Number	The encryption type.	Valid values: 0: The file system is not encrypted. 1: The file system is encrypted by using NAS-managed keys. 2: The file system is encrypted by using user-managed keys.
Ldap	List	The configurations of Lightweight Directory Access Protocol (LDAP).	This property is returned if FileSystemType is set to cpfs.
ExpiredTime	String	The expiration time of the file system.	Example: 2017-08-27T15:43:06CST.
ZoneId	String	The zone ID of the file system.	None.
Packages	List	The information about the storage plans.	None.

Examples

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "FileSystemId": {
      "Type": "String"
    }
  },
  "Resources": {
    "FileSystems": {
      "Type": "DATASOURCE::NAS::FileSystems",
      "Properties": {
        "FileSystemId": {
          "Ref": "FileSystemId"
        }
      }
    }
  },
  "Outputs": {
    "FileSystems": {
      "Description": "The list of file systems.",
      "Value": {
        "Fn::GetAtt": [
          "FileSystems",
          "FileSystems"
        ]
      }
    },
    "FileSystemIds": {
      "Description": "The list of file system IDs.",
      "Value": {
        "Fn::GetAtt": [
          "FileSystems",
          "FileSystemIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  FileSystemId:
    Type: String
Resources:
  FileSystems:
    Type: DATASOURCE::NAS::FileSystems
    Properties:
      FileSystemId:
        Ref: FileSystemId
Outputs:
  FileSystems:
    Description: The list of file systems.
    Value:
      Fn::GetAtt:
        - FileSystems
        - FileSystems
  FileSystemIds:
    Description: The list of file system IDs.
    Value:
      Fn::GetAtt:
        - FileSystems
        - FileSystemIds