How to use the ALIYUN::NAS::ProtocolMountTarget resource type - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::NAS::ProtocolMountTarget",
  "Properties": {
    "FsetId": String,
    "Path": String,
    "Description": String,
    "VpcId": String,
    "VSwitchId": String,
    "AccessGroupName": String,
    "FileSystemId": String,
    "ProtocolServiceId": String
  }
}

Properties

Property	Type	Required	Update allowed	Description	Constraints
FsetId	String	No	No	The ID of the fileset to export.	Constraints: The fileset must exist. You can create only one export directory for a fileset. You must specify either Fileset or Path.
Path	String	No	No	The path of the CPFS directory to export.	Constraints: The directory must exist in the CPFS file system. You can create only one export for the same directory. You must specify either Fileset or Path. Format: The length must be between 1 and 1024 characters. Use UTF-8 encoding. The path must start and end with a forward slash (/). The root directory is /.
Description	String	No	Yes	The description of the export directory.	Constraints: The description must be 2 to 128 characters in length. It must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. It can contain digits, colons (:), underscores (_), and hyphens (-).
VpcId	String	Yes	No	The ID of the VPC in which the export directory resides.	None
VSwitchId	String	Yes	No	The ID of the vSwitch in which the export directory resides.	None
AccessGroupName	String	No	No	The name of the permission group.	Default value: DEFAULT_VPC_GROUP_NAME.
FileSystemId	String	Yes	No	The ID of the file system.	None
ProtocolServiceId	String	Yes	No	The ID of the protocol service.	None

Return values

Fn::GetAtt

ExportId: The ID of the export directory for the protocol service.
FileSystemId: The ID of the file system.
ProtocolServiceId: The ID of the protocol service.
ProtocolMountTargetDomain: The domain name of the protocol mount target.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  FileSystemId:
    Default: cpfs-03c125afccbd****
    Type: String
  VpcId:
    Default: vpc-2zebbi27bn7w42n30****
    Type: String
  FsetId:
    Default: fset-123****
    Type: String
  ProtocolServiceId:
    Default: ptc-123****
    Type: String
  VSwitchId:
    Default: vsw-2ze34tr01i6h4l2km****
    Type: String
Resources:
  ProtocolMountTarget:
    Type: ALIYUN::NAS::ProtocolMountTarget
    Properties:
      VpcId:
        Ref: VpcId
      Description: ros_test_protocol_mount_target
      FileSystemId:
        Ref: FileSystemId
      FsetId:
        Ref: FsetId
      VSwitchId:
        Ref: VSwitchId
      AccessGroupName: DEFAULT_VPC_GROUP_NAME
      ProtocolServiceId:
        Ref: ProtocolServiceId
Outputs:
  ExportId:
    Value:
      Fn::GetAtt:
      - ProtocolMountTarget
      - ExportId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "FileSystemId": {
      "Default": "cpfs-03c125afccbd****",
      "Type": "String"
    },
    "VpcId": {
      "Default": "vpc-2zebbi27bn7w42n30****",
      "Type": "String"
    },
    "FsetId": {
      "Default": "fset-123****",
      "Type": "String"
    },
    "ProtocolServiceId": {
      "Default": "ptc-123****",
      "Type": "String"
    },
    "VSwitchId": {
      "Default": "vsw-2ze34tr01i6h4l2km****",
      "Type": "String"
    }
  },
  "Resources": {
    "ProtocolMountTarget": {
      "Type": "ALIYUN::NAS::ProtocolMountTarget",
      "Properties": {
        "VpcId": {
          "Ref": "VpcId"
        },
        "Description": "ros_test_protocol_mount_target",
        "FileSystemId": {
          "Ref": "FileSystemId"
        },
        "FsetId": {
          "Ref": "FsetId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "AccessGroupName": "DEFAULT_VPC_GROUP_NAME",
        "ProtocolServiceId": {
          "Ref": "ProtocolServiceId"
        }
      }
    }
  },
  "Outputs": {
    "ExportId": {
      "Value": {
        "Fn::GetAtt": [
          "ProtocolMountTarget",
          "ExportId"
        ]
      }
    }
  }
}