All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ECD-BulkyRenewDesktops

Last Updated:Dec 04, 2024

Template name

ACS-ECD-BulkyRenewDesktops

Execute Now

Template description

Renews multiple subscription cloud desktops at a time.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Data type

Required

Default value

Limit

autoPay

Specifies whether to enable the automatic payment feature.

Boolean

Yes

regionId

The region ID.

String

No

{{ ACS::RegionId }}

desktopIds

The IDs of the cloud desktops.

List

No

[]

periodUnit

The unit of the renewal duration. Valid values:

String

No

Month

period

The renewal duration.

Number

No

1

rateControl

The rate control settings.

Json

No

{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}

OOSAssumeRole

The RAM role that is assumed by CloudOps Orchestration Service (OOS).

String

No

""

Output parameters

N/A.

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecd:RenewDesktops"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

ACS-ECD-BulkyRenewDesktops

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Bulky renew subscription cloud desktops
  name-en: ACS-ECD-BulkyRenewDesktops
Parameters:
  regionId:
    Type: String
    Label:
      en: RegionId
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  desktopIds:
    Label:
      en: DesktopIds
    Type: List
    Default: [ ]
  periodUnit:
    Label:
      en: PeriodUnit
    Type: String
    AllowedValues:
      - Year
      - Month
    Default: Month
  period:
    Description:
      en: >-
        The valid values of this parameter are determined by the PeriodUnit value.
        If PeriodUnit is set to Month, the valid values of the Period parameter are 1, 2, 3, and 6.
        If PeriodUnit is set to Year, the valid values of the Period parameter are 1, 2, 3, 4, and 5.
    Label:
      en: Period
    Type: Number
    Default: 1
    MinValue: 1
    MaxValue: 6
  autoPay:
    Description:
      en: >-
        Valid values:
        true: enables automatic payment. Make sure that you have sufficient balance in your account. Otherwise, abnormal orders are generated
        false: generates the order with no payment made. You can log on to the EDS console and complete the payment based on the order number     
    Label:
      en: AutoPay
    Type: Boolean
  rateControl:
    Label:
      en: RateControl
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: renewDesktop
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Renew desktops
    Properties:
      Service: ECD
      API: RenewDesktops
      Parameters:
        RegionId: '{{ regionId }}'
        DesktopId:
          - '{{ ACS::TaskLoopItem }}'
        Period: '{{ period }}'
        PeriodUnit: '{{ periodUnit }}'
        AutoPay: '{{ autoPay }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ desktopIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - periodUnit
          - period
          - autoPay
        Label:
          default:
            en: Configure Parameters
      - Parameters:
          - regionId
          - desktopIds
        Label:
          default:
            en: Select ECD Desktops
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            en: Control Options