How to use ALIYUN::ECD::SimpleOfficeSite to create a workspace of the convenience account type - Resource Orchestration Service

ALIYUN::ECD::SimpleOfficeSite is used to create a workspace of the convenience account type.

Syntax

{
  "Type": "ALIYUN::ECD::SimpleOfficeSite",
  "Properties": {
    "VerifyCode": String,
    "NeedVerifyZeroDevice": Boolean,
    "CenOwnerId": Integer,
    "Bandwidth": Integer,
    "VSwitchId": String,
    "EnableAdminAccess": Boolean,
    "CloudBoxOfficeSite": Boolean,
    "CenId": String,
    "OfficeSiteName": String,
    "DesktopAccessType": String,
    "CidrBlock": String,
    "EnableInternetAccess": Boolean,
    "VpcType": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
VerifyCode	String	No	No	The verification code.	If the Cloud Enterprise Network (CEN) instance that corresponds to CenId belongs to another Alibaba Cloud account, you must call the SendVerifyCode operation to obtain a verification code.
NeedVerifyZeroDevice	Boolean	No	No	Specifies whether to enable trusted device verification.	Valid values: true false
CenOwnerId	Integer	No	No	The ID of the Alibaba Cloud account to which the CEN instance belongs.	If you do not specify CenId or the CEN instance that corresponds to CenId belongs to the current Alibaba Cloud account, leave CenOwnerId empty. If you specify CenId and the CEN instance that corresponds to CenId belongs to another Alibaba Cloud account, set CenOwnerId to the ID of the Alibaba Cloud account.
Bandwidth	Integer	No	No	The maximum public bandwidth.	Valid values: 10 to 200. Unit: Mbit/s. You can specify this property when `EnableInternetAccess` is set to `true`.
VSwitchId	String	No	No	The ID of the vSwitch in the virtual private cloud (VPC).	This property must be specified when you create a cloud box-based workspace.
EnableAdminAccess	Boolean	No	No	Specifies whether to grant the permissions of the local administrator to end users of the cloud desktops that belong to the workspace.	Valid values: true (default) false
CloudBoxOfficeSite	Boolean	No	No	Specifies whether the workspace is a cloud box-based workspace.	Valid values: true false
VpcType	String	No	No	The type of the office network.	Valid values: standard: advanced basic: basic
CenId	String	No	No	The ID of the CEN instance.	Note If you want to connect to your cloud desktops over a VPC, you can attach the network of the workspace to the CEN instance. The CEN instance is connected to the on-premises network over VPN Gateway or Express Connect.
OfficeSiteName	String	No	No	The name of the workspace.	The name must be 2 to 255 characters in length. The name must start with a letter and cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).
DesktopAccessType	String	No	No	The method that is used to connect to cloud desktops.	Note The VPC connection method depends on Alibaba Cloud PrivateLink. You can use PrivateLink for free. When you set this property to VPC or Any, PrivateLink is automatically activated.
CidrBlock	String	No	No	The IPv4 CIDR block in the secure office network of the workspace.	The system creates a VPC based on the IPv4 CIDR block that you specify. We recommend that you set the IPv4 CIDR block to one of the following CIDR blocks or their subnets: `10.0.0.0/12`, `172.16.0.0/12`, and `192.168.0.0/16`. If you set the IPv4 CIDR block to 10.0.0.0/12 or 172.16.0.0/12, the mask is 12 to 24 bits in length. If you set the IPv4 CIDR block to 192.168.0.0/16, the mask is 16 to 24 bits in length.
EnableInternetAccess	Boolean	No	No	Specifies whether to enable Internet access.	Valid values: true false (default)

Return values

Fn::GetAtt

OfficeSiteId: the workspace ID.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  OfficeSiteName:
    Type: String
    Description: The name of the workspace. The name must be 2 to 255 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).
    Default: test
Resources:
  SimpleOfficeSite:
    Type: ALIYUN::ECD::SimpleOfficeSite
    Properties:
      OfficeSiteName:
        Ref: OfficeSiteName
      CidrBlock: 172.16.0.0/12
Outputs:
  OfficeSiteId:
    Description: The ID of the workspace.
    Value:
      Fn::GetAtt:
        - SimpleOfficeSite
        - OfficeSiteId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "OfficeSiteName": {
      "Type": "String",
      "Description": "The name of the workspace. The name must be 2 to 255 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).",
      "Default": "test"
    }
  },
  "Resources": {
    "SimpleOfficeSite": {
      "Type": "ALIYUN::ECD::SimpleOfficeSite",
      "Properties": {
        "OfficeSiteName": {
          "Ref": "OfficeSiteName"
        },
        "CidrBlock": "172.16.0.0/12"
      }
    }
  },
  "Outputs": {
    "OfficeSiteId": {
      "Description": "The ID of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "SimpleOfficeSite",
          "OfficeSiteId"
        ]
      }
    }
  }
}