All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::NAS::ProtocolService

更新時間:Nov 23, 2023

ALIYUN::NAS::ProtocolService is used to create a protocol service for a Cloud Paralleled File System (CPFS) file system.

Syntax

{
  "Type": "ALIYUN::NAS::ProtocolService",
  "Properties": {
    "Description": String,
    "VpcId": String,
    "ProtocolType": String,
    "ProtocolSpec": String,
    "VSwitchId": String,
    "FileSystemId": String,
    "Throughput": Integer
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Description

String

No

Yes

The description of the protocol service.

Limits:

  • The description must be 2 to 128 characters in length.

  • The description must start with a letter and 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 protocol service.

The VPC ID of the protocol service must be the same as the VPC of the file system.

ProtocolType

String

Yes

No

The protocol type of the protocol service.

Set the value to NFS (default). A value of NFS indicates that the protocol service supports access over the Network File System (NFS) protocol.

ProtocolSpec

String

Yes

No

The specification of the protocol service.

Set the value to General (default).

VSwitchId

String

Yes

No

The vSwitch ID of the protocol service.

None.

FileSystemId

String

Yes

No

The ID of the file system.

None.

Throughput

Integer

No

No

The bandwidth of the protocol service.

Unit: MB/s.

Return values

Fn::GetAtt

  • FileSystemId: the ID of the file system.

  • ProtocolServiceId: the ID of the protocol service.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      FileSystemId:
        Default: cpfs-03c125afccbd****
        Type: String
      VpcId:
        Default: vpc-2zebbi27bn7w42n30****
        Type: String
      VSwitchId:
        Default: vsw-2ze34tr01i6h4l2km****
        Type: String
    Resources:
      ProtocolService:
        Type: ALIYUN::NAS::ProtocolService
        Properties:
          ProtocolType: NFS
          FileSystemId:
            Ref: FileSystemId
          VpcId:
            Ref: VpcId
          VSwitchId:
            Ref: VSwitchId
          Description: ros_test_protocol_service
    Outputs:
      ProtocolServiceId:
        Value:
          Fn::GetAtt:
          - ProtocolService
          - ProtocolServiceId
      FileSystemId:
        Value:
          Fn::GetAtt:
          - ProtocolService
          - FileSystemId
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "FileSystemId": {
          "Default": "cpfs-03c125afccbd****",
          "Type": "String"
        },
        "VpcId": {
          "Default": "vpc-2zebbi27bn7w42n30****",
          "Type": "String"
        },
        "VSwitchId": {
          "Default": "vsw-2ze34tr01i6h4l2km****",
          "Type": "String"
        }
      },
      "Resources": {
        "ProtocolService": {
          "Type": "ALIYUN::NAS::ProtocolService",
          "Properties": {
            "ProtocolType": "NFS",
            "FileSystemId": {
              "Ref": "FileSystemId"
            },
            "VpcId": {
              "Ref": "VpcId"
            },
            "VSwitchId": {
              "Ref": "VSwitchId"
            },
            "Description": "ros_test_protocol_service"
          }
        }
      },
      "Outputs": {
        "ProtocolServiceId": {
          "Value": {
            "Fn::GetAtt": [
              "ProtocolService",
              "ProtocolServiceId"
            ]
          }
        },
        "FileSystemId": {
          "Value": {
            "Fn::GetAtt": [
              "ProtocolService",
              "FileSystemId"
            ]
          }
        }
      }
    }