All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::ECD::Bundle

Last Updated:Aug 12, 2024

ALIYUN::ECD::Bundle is used to create a custom desktop template.

Syntax

{
  "Type": "ALIYUN::ECD::Bundle",
  "Properties": {
    "Description": String,
    "RootDiskSizeGib": Integer,
    "Language": String,
    "RootDiskPerformanceLevel": String,
    "DesktopType": String,
    "BundleName": String,
    "ImageId": String,
    "UserDiskPerformanceLevel": String,
    "UserDiskSizeGib": List
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Description

String

No

Yes

The description of the template.

None.

RootDiskSizeGib

Integer

Yes

No

The size of the system disk.

Unit: GiB.

The value of this property must be consistent with the system disk size supported by the cloud desktop type. For more information, see Cloud desktop types.

Language

String

No

Yes

The language of the OS.

This property is available only for system images.

Valid values:

  • zh-CN: Simplified Chinese

  • zh-HK: Traditional Chinese

  • en-US: English

  • ja-JP: Japanese

RootDiskPerformanceLevel

String

No

No

The performance level (PL) of the system disk.

You can specify this property when the cloud desktop type is Graphics or High Frequency.

Valid values:

  • PL0

  • PL1

  • PL2

  • PL3

For more information about the differences between disks of different PLs, see ESSDs.

DesktopType

String

Yes

No

The cloud desktop type.

You can call the DescribeBundles operation to query desktop templates and obtain the supported desktop type from the value of DesktopType.

Note

You can select GPU-accelerated desktop types only when you use GPU-accelerated images.

BundleName

String

No

Yes

The name of the desktop template.

None.

ImageId

String

Yes

Yes

The image ID.

None.

UserDiskPerformanceLevel

String

No

No

The PL of the data disk.

You can specify this property when the cloud desktop type is Graphics or High Frequency.

Valid values:

  • PL0

  • PL1

  • PL2

  • PL3

For more information about the differences between disks of different PLs, see ESSDs.

UserDiskSizeGib

List

Yes

No

The size of the data disk.

You can configure only one data disk. Unit: GiB.

The value of this property must be consistent with the data disk size supported by the cloud desktop type. For more information, see Cloud desktop types.

Note

The data disk size that you specify in the template must be greater than the data disk size that is contained in the image.

Return values

Fn::GetAtt

BundleId: the ID of the desktop template.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RootDiskSizeGib:
    Type: Number
    Description: The root disk size gib.
    Default: 40
  DesktopType:
    Type: String
    Description: |-
      Desktop specifications.You can call Describundles to query the desktop bundle and get the currently supported desktop specification from the returned desktopType.
      Explain that ordinary mirrors cannot choose the GPU specifications, and the GPU type mirror can only choose the GPU specification.
    Default: eds.enterprise_office.8c8g
  ImageId:
    Type: String
    Description: The ID of the image.
    Default: desktopimage-windows-server-2019-64-ch-asp
  UserDiskSizeGib:
    Type: Json
    Description: |-
      The size of the data disk. Currently, only one data disk can be set. Unit: GiB.
      - The size of the data disk that supports the setting corresponds to the specification.
      - The data disk size (user_disk_size_gib) set in the template must be greater than the data disk size (data_disk_size) in the mirror.
    MaxLength: 1
    Default:
      - 40
Resources:
  Bundle:
    Type: ALIYUN::ECD::Bundle
    Properties:
      RootDiskSizeGib:
        Ref: RootDiskSizeGib
      DesktopType:
        Ref: DesktopType
      ImageId:
        Ref: ImageId
      UserDiskSizeGib:
        Ref: UserDiskSizeGib
Outputs:
  BundleId:
    Description: Desktop bundle ID.
    Value:
      Fn::GetAtt:
        - Bundle
        - BundleId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RootDiskSizeGib": {
      "Type": "Number",
      "Description": "The root disk size gib.",
      "Default": 40
    },
    "DesktopType": {
      "Type": "String",
      "Description": "Desktop specifications.You can call Describundles to query the desktop bundle and get the currently supported desktop specification from the returned desktopType.\nExplain that ordinary mirrors cannot choose the GPU specifications, and the GPU type mirror can only choose the GPU specification.",
      "Default": "eds.enterprise_office.8c8g"
    },
    "ImageId": {
      "Type": "String",
      "Description": "The ID of the image.",
      "Default": "desktopimage-windows-server-2019-64-ch-asp"
    },
    "UserDiskSizeGib": {
      "Type": "Json",
      "Description": "The size of the data disk. Currently, only one data disk can be set. Unit: GiB.\n- The size of the data disk that supports the setting corresponds to the specification.\n- The data disk size (user_disk_size_gib) set in the template must be greater than the data disk size (data_disk_size) in the mirror.",
      "MaxLength": 1,
      "Default": [40]
    }
  },
  "Resources": {
    "Bundle": {
      "Type": "ALIYUN::ECD::Bundle",
      "Properties": {
        "RootDiskSizeGib": {
          "Ref": "RootDiskSizeGib"
        },
        "DesktopType": {
          "Ref": "DesktopType"
        },
        "ImageId": {
          "Ref": "ImageId"
        },
        "UserDiskSizeGib": {
          "Ref": "UserDiskSizeGib"
        }
      }
    }
  },
  "Outputs": {
    "BundleId": {
      "Description": "Desktop bundle ID.",
      "Value": {
        "Fn::GetAtt": [
          "Bundle",
          "BundleId"
        ]
      }
    }
  }
}