AI 助理
备案控制台
文档
输入文档关键字查找
首页 资源编排 开发参考 资源类型 ECD ALIYUN::ECD::DesktopGroup

ALIYUN::ECD::DesktopGroup

更新时间：
产品详情
我的收藏

ALIYUN::ECD::DesktopGroup类型用于创建一个云电脑池。

语法

{
  "Type": "ALIYUN::ECD::DesktopGroup",
  "Properties": {
    "ConnectDuration": Integer,
    "DesktopGroupName": String,
    "AutoRenew": Boolean,
    "VolumeEncryptionEnabled": Boolean,
    "AllowBufferCount": Integer,
    "GroupVersion": Integer,
    "KeepDuration": Integer,
    "IdleDisconnectDuration": Integer,
    "MaxDesktopsCount": Integer,
    "ResetType": Integer,
    "MinDesktopsCount": Integer,
    "Comments": String,
    "PolicyGroupId": String,
    "EndUserIds": List,
    "Period": Integer,
    "DefaultInitDesktopCount": Integer,
    "AutoPay": Boolean,
    "OfficeSiteId": String,
    "BundleId": String,
    "StopDuration": Integer,
    "ChargeType": String,
    "VolumeEncryptionKey": String,
    "AllowAutoSetup": Integer,
    "BuyDesktopsCount": Integer,
    "PeriodUnit": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

BundleId

String

是

否

云电脑模板ID。

无

ChargeType

String

是

否

云电脑的付费类型。

取值：

  • PostPaid：按量付费。

  • PrePaid：包年包月。

OfficeSiteId

String

是

否

云电脑池所属的办公网络ID。

无

PolicyGroupId

String

是

否

云电脑池关联的策略ID。

无

AllowAutoSetup

Integer

否

否

是否允许包年包月云电脑池自动创建云电脑。

即当参数ChargeType取值为PrePaid时才生效，且为必选值。取值：

  • 0：不允许。

  • 1：允许。

AllowBufferCount

Integer

否

否

按量付费云电脑池内允许预留的云电脑数量。

当参数ChargeType取值为PostPaid时才生效，且为必选值。取值范围：

  • 0：不预留。

  • N：预留N台（1≤N≤100）。

AutoPay

Boolean

否

否

是否自动支付包年包月订单。

无

AutoRenew

Boolean

否

否

是否为包年包月云电脑池开启自动续费。

取值：

  • true：开启自动续费。

  • false：不开启自动续费。

BuyDesktopsCount

Integer

否

否

购买云电脑数量。

  • 对于包年包月云电脑池：购买云电脑数量。

  • 对于按量付费云电脑池：池内云电脑最小创建数量。

取值范围：0~200。

Comments

String

否

否

备注信息。

无

ConnectDuration

Integer

否

否

会话处于连接状态的最大时长。

会话连接时长达到此值时将自动断开连接。单位：毫秒。取值范围：900000（15 分钟）~345600000（4 天）。

DefaultInitDesktopCount

Integer

否

否

创建云电脑池时默认生成的云电脑数量。

默认值为1。

DesktopGroupName

String

否

否

云电脑池名称。

不超过30个字符。必须以大小字母或中文开头，不能以http://和https://开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、点号（.）或者短划线（-）。

EndUserIds

List

否

否

云电脑池的授权用户ID列表。

无

GroupVersion

Integer

否

否

云电脑池版本。

无

IdleDisconnectDuration

Integer

否

否

用户会话建立连接后，如果在该最大时长内，始终没有任何键盘或鼠标操作，则该会话断开连接。

单位：毫秒。取值范围为360000（6分钟）~3600000（60分钟）。

在达到该时长的30秒前，会话中的终端用户将收到保存文档数据的提示消息，此时终端用户需及时保存文档数据，避免丢失。

KeepDuration

Integer

否

否

会话断开连接后继续保留的时间。

单位为毫秒，取值范围为 180000（3分钟）~345600000（4天）。取值为0时，表示始终保留。

当会话因为用户主动断开或因为其他因素意外断开时，从断开的时刻开始计算，若在该保留时长内用户始终未重新建立与该会话的连接，则该会话注销，未保存的数据都将销毁；若在该保留时长内，用户重新建立连接成功，则仍可进入原来的会话，仍可访问对话断开之前的数据。

MaxDesktopsCount

Integer

否

否

按量付费云电脑池内能容纳的云电脑最大数量。

取值范围：0~500。

MinDesktopsCount

Integer

否

否

包年包月云电脑池内自动创建云电脑的上限。

即当参数ChargeType取值为PrePaid时才生效，且为必选值。默认值为1，取值范围为0~500。

Period

Integer

否

否

包年包月云电脑池的购买时长。

当参数ChargeType取值为PrePaid时才生效，且为必选值。单位由PeriodUnit指定。

  • 如果PeriodUnit为Month，该参数的取值范围：

    • 1

    • 2

    • 3

    • 6

  • 如果PeriodUnit为Year，该参数的取值范围：

    • 1

    • 2

    • 3

    • 4

    • 5

PeriodUnit

String

否

否

包年包月计费方式的时长单位。

取值：

  • Month

  • Year

ResetType

Integer

否

否

云电脑重置类型。

取值：

  • 0：不重置。

  • 1：只重置系统盘。

  • 2：只重置用户磁盘。

  • 3：重置系统盘和用户磁盘。

StopDuration

Integer

否

否

空闲关机时间。

当云电脑空闲时长达到该值时，自动关机。关机后如果有用户连接，会自动开机。单位：毫秒。

VolumeEncryptionEnabled

Boolean

否

否

是否开启磁盘加密。

无

VolumeEncryptionKey

String

否

否

开启磁盘加密的情况下使用的KMS的密钥ID。

无

返回值

Fn::GetAtt

DesktopGroupId：云电脑池ID。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PolicyGroupId:
    Type: String
    Description:
      en: The ID of the policy.
    Required: true
  OfficeSiteId:
    Type: String
    Description:
      en: The ID of the workspace.
    Required: true
  BundleId:
    Type: String
    Description:
      en: The ID of the desktop template.
    Required: true
  ChargeType:
    Type: String
    Description:
      en: |-
        The billing method of the cloud desktops in the desktop group.  Enumeration Value:
        PostPaid
        PrePaid
    AllowedValues:
      - PostPaid
      - PrePaid
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ECD::DesktopGroup
    Properties:
      PolicyGroupId:
        Ref: PolicyGroupId
      OfficeSiteId:
        Ref: OfficeSiteId
      BundleId:
        Ref: BundleId
      ChargeType:
        Ref: ChargeType
Outputs:
  DesktopGroupId:
    Description: Id of created DesktopGroup
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DesktopGroupId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PolicyGroupId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the policy."
      },
      "Required": true
    },
    "OfficeSiteId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the workspace."
      },
      "Required": true
    },
    "BundleId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the desktop template."
      },
      "Required": true
    },
    "ChargeType": {
      "Type": "String",
      "Description": {
        "en": "The billing method of the cloud desktops in the desktop group.  Enumeration Value:\nPostPaid\nPrePaid"
      },
      "AllowedValues": [
        "PostPaid",
        "PrePaid"
      ],
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ECD::DesktopGroup",
      "Properties": {
        "PolicyGroupId": {
          "Ref": "PolicyGroupId"
        },
        "OfficeSiteId": {
          "Ref": "OfficeSiteId"
        },
        "BundleId": {
          "Ref": "BundleId"
        },
        "ChargeType": {
          "Ref": "ChargeType"
        }
      }
    }
  },
  "Outputs": {
    "DesktopGroupId": {
      "Description": "Id of created DesktopGroup",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DesktopGroupId"
        ]
      }
    }
  }
}
上一篇：ALIYUN::ECD::Desktops下一篇：ALIYUN::ECD::NetworkPackage
文档推荐