ALIYUN::ENS::VSwitch - Resource Orchestration Service

ALIYUN::ENS::VSwitch is used to create a vSwitch.

Syntax

{
  "Type": "ALIYUN::ENS::VSwitch",
  "Properties": {
    "Description": String,
    "CidrBlock": String,
    "VSwitchName": String,
    "NetworkId": String,
    "EnsRegionId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
Description	String	No	Yes	The description of the vSwitch.	The description must be 2 to 256 characters in length. It must start with a letter and cannot start with `http://` or `https://`.
CidrBlock	String	Yes	No	The CIDR block of the vSwitch.	The vSwitch CIDR block must meet the following requirements: The mask of the vSwitch CIDR block must be 16 to 29 bits in length. The vSwitch CIDR block must fall within the CIDR block of the VPC to which the vSwitch belongs. The vSwitch CIDR block cannot be the same as the destination CIDR block in a route entry of the VPC to which the vSwitch belongs. However, the vSwitch CIDR block can be a subset of the destination CIDR block.
VSwitchName	String	No	Yes	The vSwitch name.	The name must meet the following requirements: The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
NetworkId	String	Yes	No	The ID of the network to which the vSwitch that you want to create belongs.	None.
EnsRegionId	String	Yes	No	The ID of the Edge Node Service (ENS) node.	None.

Return values

Fn::GetAtt

VSwitchId: the vSwitch ID.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CidrBlock:
    Description:
      en: 'The CIDR block of the vSwitch. Take note of the following limits:

        The subnet mask must be 16 to 29 bits in length.

        The CIDR block of the vSwitch must fall within the CIDR block of the VPC to
        which the vSwitch belongs.

        The CIDR block of the vSwitch cannot be the same as the destination CIDR block
        in a route entry of the VPC. However, it can be a subset of the destination
        CIDR block.'
    Required: true
    Type: String
  Description:
    AssociationProperty: TextArea
    Description:
      en: 'The description of the vSwitch.

        The description must be 2 to 256 characters in length. It must start with
        a letter but cannot start with http:// or https://.'
    Required: false
    Type: String
  EnsRegionId:
    Description:
      en: The ID of the edge node.
    Required: true
    Type: String
  NetworkId:
    Description:
      en: The ID of the network to which the vSwitch that you want to create belongs.
    Required: true
    Type: String
  VSwitchName:
    Description:
      en: 'The name of the vSwitch. The name must meet the following requirements:

        The name must be 2 to 128 characters in length.

        The name must start with a letter and cannot start with http:// or https://.
        It can contain letters, digits, colons (:), underscores (_), and hyphens (-).

        Default value: null.'
    Required: false
    Type: String
Resources:
  VSwitch:
    Properties:
      CidrBlock:
        Ref: CidrBlock
      Description:
        Ref: Description
      EnsRegionId:
        Ref: EnsRegionId
      NetworkId:
        Ref: NetworkId
      VSwitchName:
        Ref: VSwitchName
    Type: ALIYUN::ENS::VSwitch
Outputs:
  VSwitchId:
    Description: The ID of the vSwitch.
    Value:
      Fn::GetAtt:
      - VSwitch
      - VSwitchId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Description": {
      "AssociationProperty": "TextArea",
      "Type": "String",
      "Description": {
        "en": "The description of the vSwitch.\nThe description must be 2 to 256 characters in length. It must start with a letter but cannot start with http:// or https://."
      },
      "Required": false
    },
    "CidrBlock": {
      "Type": "String",
      "Description": {
        "en": "The CIDR block of the vSwitch. Take note of the following limits:\nThe subnet mask must be 16 to 29 bits in length.\nThe CIDR block of the vSwitch must fall within the CIDR block of the VPC to which the vSwitch belongs.\nThe CIDR block of the vSwitch cannot be the same as the destination CIDR block in a route entry of the VPC. However, it can be a subset of the destination CIDR block."
      },
      "Required": true
    },
    "VSwitchName": {
      "Type": "String",
      "Description": {
        "en": "The name of the vSwitch. The name must meet the following requirements:\nThe name must be 2 to 128 characters in length.\nThe name must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).\nDefault value: null."
      },
      "Required": false
    },
    "NetworkId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the network to which the vSwitch that you want to create belongs."
      },
      "Required": true
    },
    "EnsRegionId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the edge node."
      },
      "Required": true
    }
  },
  "Resources": {
    "VSwitch": {
      "Type": "ALIYUN::ENS::VSwitch",
      "Properties": {
        "Description": {
          "Ref": "Description"
        },
        "CidrBlock": {
          "Ref": "CidrBlock"
        },
        "VSwitchName": {
          "Ref": "VSwitchName"
        },
        "NetworkId": {
          "Ref": "NetworkId"
        },
        "EnsRegionId": {
          "Ref": "EnsRegionId"
        }
      }
    }
  },
  "Outputs": {
    "VSwitchId": {
      "Description": "The ID of the vSwitch.",
      "Value": {
        "Fn::GetAtt": [
          "VSwitch",
          "VSwitchId"
        ]
      }
    }
  }
}