ALIYUN::ECD::SimpleOfficeSite - Create a convenience account workspace in ROS - Resource Orchestration Service

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 CEN instance specified by CenId belongs to another Alibaba Cloud account, 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 Alibaba Cloud account ID of the CEN instance owner.	Leave empty if CenId is not specified or the CEN instance belongs to the current account. Set to the Alibaba Cloud account ID if CenId is specified and the CEN instance belongs to another account.
Bandwidth	Integer	No	No	The maximum public bandwidth.	Valid values: 10 to 200. Unit: Mbit/s. Specify this property only when `EnableInternetAccess` is set to `true`.
VSwitchId	String	No	No	The vSwitch ID in the VPC.	Required for cloud box-based workspaces.
EnableAdminAccess	Boolean	No	No	Specifies whether to grant local administrator permissions to end users of cloud desktops in the workspace.	Valid values: true (default) false
CloudBoxOfficeSite	Boolean	No	No	Specifies whether the workspace is cloud box-based.	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 CEN instance ID.	Note To connect cloud desktops over a VPC, attach the workspace network to a CEN instance that connects to your on-premises network through VPN Gateway or Express Connect.
OfficeSiteName	String	No	No	The workspace name.	2 to 255 characters. Must start with a letter. Cannot start with `http://` or `https://`. Can contain letters, digits, colons (:), underscores (_), and hyphens (-).
DesktopAccessType	String	No	No	The method used to connect to cloud desktops.	Note VPC connections use Alibaba Cloud PrivateLink, which is free of charge. Setting this property to VPC or Any automatically activates PrivateLink.
CidrBlock	String	No	No	The IPv4 CIDR block of the workspace secure office network.	A VPC is created based on the specified CIDR block. Recommended CIDR blocks: `10.0.0.0/12`, `172.16.0.0/12`, and `192.168.0.0/16`, or their subnets. For 10.0.0.0/12 and 172.16.0.0/12, the mask length is 12 to 24 bits. For 192.168.0.0/16, the mask length is 16 to 24 bits.
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"
        ]
      }
    }
  }
}