ALIYUN::NAS::ProtocolMountTarget - Resource Orchestration Service

ALIYUN::NAS::ProtocolMountTarget is used to create an export directory for a protocol 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	Editable	Description	Constraint
FsetId	String	No	No	The ID of the fileset that you want to export.	The following limits apply: The fileset already exists. You can create only one export directory for a filest. You must and can specify only one of Fileset and Path.
Path	String	No	No	The path of the Cloud Paralleled File System (CPFS) directory that you want to export.	The following limits apply: The directory already exists in CPFS. You can create only one export directory for a directory. You must and can specify only one of Fileset and Path. Value format: The path must be 1 to 1,024 characters in length. The path must be encoded in UTF-8. The path must start and end with a forward slash (/). The root directory must be /.
Description	String	No	Yes	The description of the export directory.	The following limits apply: The description must be 2 to 128 characters in length. The description must start with a letter but cannot start with `http://` or `https://`. The description can contain letters, digits, colons (:), underscores (_), and hyphens (-).
VpcId	String	Yes	No	The virtual private cloud (VPC) ID of the export directory.	None.
VSwitchId	String	Yes	No	The vSwitch ID of the export directory.	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.
FileSystemId: the ID of the file system.
ProtocolServiceId: the ID of the protocol service.
ProtocolMountTargetDomain: the destination domain of the mounted protocol service.

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"
        ]
      }
    }
  }
}