All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ECD-BulkyModifyDesktopAutoRenewAttribute

Last Updated:Dec 04, 2024

Template name

ACS-ECD-BulkyModifyDesktopAutoRenewAttribute

Execute Now

Template description

Modifies the auto renewal settings of multiple cloud desktops at a time.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Data type

Required

Default value

Limit

desktopIds

The IDs of the cloud desktops.

List

Yes

renewalPeriodUnit

The unit of the renewal duration of the instances.

String

Yes

renewalPeriod

The renewal duration of the instances.

Number

Yes

renewalStatus

The auto-renewal status of the cloud desktops.

String

Yes

regionId

The region ID.

String

No

{{ ACS::RegionId }}

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": [
                "bssopenapi:SetRenewal"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

ACS-ECD-BulkyModifyDesktopAutoRenewAttribute

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Bulky modify ECD desktop auto renew attribute 
  name-en: ACS-ECD-BulkyModifyDesktopAutoRenewAttribute 
Parameters:
  regionId:
    Type: String
    Label:
      en: RegionId       
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  desktopIds:
    Label:
      en: DesktopIds       
    Type: List
  renewalPeriodUnit:
    Label:
      en: RenewalPeriodUnit      
    Type: String
    AllowedValues:
      - M
      - Y
  renewalPeriod:
    Description:
      en: 'Valid values: 1, 2, 3, 6, 12'      
    Label:
      en: RenewalPeriod       
    Type: Number
    AllowedValues:
      - 1
      - 2
      - 3
      - 6
      - 12
  renewalStatus:
    Description:
      en: >-
        Valid values:
        AutoRenewal: Auto-renewal is enabled for the instance.
        Normal: Auto-renewal is disabled for the instance.
        NotRenewal: The instance will not be renewed upon expiration.  
    Label:
      en: RenewalStatus      
    Type: String
    AllowedValues:
      - AutoRenewal
      - Normal
      - NotRenewal
  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: modifyDesktopAutoRenewAttribute
    Action: ACS::ECD::SetRenewal
    Description:
      en: Modifies desktop auto renew attr       
    Properties:
      regionId: '{{ regionId }}'
      desktopId: '{{ ACS::TaskLoopItem }}'
      renewalPeriod: '{{ renewalPeriod }}'
      renewalPeriodUnit: '{{ renewalPeriodUnit }}'
      renewalStatus: '{{ renewalStatus }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ desktopIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - renewalPeriodUnit
          - renewalPeriod
          - renewalStatus
        Label:
          default:
            en: Configure Parameters
      - Parameters:
          - regionId
          - desktopIds
        Label:
          default:
            en: Select ECD Desktops
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            en: Control Options