Query information about a file system - Resource Orchestration Service

DATASOURCE::NAS::FileSystem is used to query the information about a file system.

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

FileSystemId

String

Yes

The ID of the file system.

None.

RefreshOptions

String

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

Description: the description of the file system.
StorageType: the storage type.
Ldap: the configurations of Lightweight Directory Access Protocol (LDAP).
ZoneId: the zone ID of the file system.
KmsKeyId: the ID of the Key Management Service (KMS) key.
CreateTime: the time when the file system was created.
MeteredSize: the storage usage of the Infrequent Access (IA) storage class.
EncryptType: the encryption type.
Capacity: the capacity of the file system.
ProtocolType: the protocol type of the file system.
FileSystemType: the type of the file system.
Bandwidth: the bandwidth of the file system.
ExpiredTime: the expiration time of the file system.
FileSystemId: the ID of the file system.
PaymentType: the billing method.
Tags: the tags of the file system.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  FileSystemId:
    Description:
      en: The ID of the file system to be created.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      FileSystemId:
        Ref: FileSystemId
    Type: DATASOURCE::NAS::FileSystem
Outputs:
  Bandwidth:
    Description: Maximum file system throughput.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Bandwidth
  Capacity:
    Description: File system capacity.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Capacity
  CreateTime:
    Description: CreateTime.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  Description:
    Description: File system description.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Description
  EncryptType:
    Description: Whether the file system is encrypted.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EncryptType
  ExpiredTime:
    Description: ExpiredTime.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ExpiredTime
  FileSystemId:
    Description: The ID of the file system to be created.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - FileSystemId
  FileSystemType:
    Description: File system type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - FileSystemType
  KmsKeyId:
    Description: The ID of the KMS key.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - KmsKeyId
  Ldap:
    Description: Ldap.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Ldap
  MeteredSize:
    Description: MeteredSize.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MeteredSize
  PaymentType:
    Description: ChargeType.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PaymentType
  ProtocolType:
    Description: File transfer protocol type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ProtocolType
  StorageType:
    Description: Storage type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - StorageType
  Tags:
    Description: Tags.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Tags
  ZoneId:
    Description: The zone ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ZoneId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "FileSystemId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the file system to be created."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::NAS::FileSystem",
      "Properties": {
        "FileSystemId": {
          "Ref": "FileSystemId"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "File system description.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "StorageType": {
      "Description": "Storage type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageType"
        ]
      }
    },
    "Ldap": {
      "Description": "Ldap.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ldap"
        ]
      }
    },
    "ZoneId": {
      "Description": "The zone ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "KmsKeyId": {
      "Description": "The ID of the KMS key.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "KmsKeyId"
        ]
      }
    },
    "CreateTime": {
      "Description": "CreateTime.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "MeteredSize": {
      "Description": "MeteredSize.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MeteredSize"
        ]
      }
    },
    "EncryptType": {
      "Description": "Whether the file system is encrypted.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EncryptType"
        ]
      }
    },
    "Capacity": {
      "Description": "File system capacity.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Capacity"
        ]
      }
    },
    "ProtocolType": {
      "Description": "File transfer protocol type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ProtocolType"
        ]
      }
    },
    "FileSystemType": {
      "Description": "File system type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "FileSystemType"
        ]
      }
    },
    "Bandwidth": {
      "Description": "Maximum file system throughput.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bandwidth"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "ExpiredTime.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "FileSystemId": {
      "Description": "The ID of the file system to be created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "FileSystemId"
        ]
      }
    },
    "PaymentType": {
      "Description": "ChargeType.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "Tags": {
      "Description": "Tags.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    }
  }
}