ACS-ECS-BulkyModifyInstanceMaintenanceAttributes - CloudOps Orchestration Service

Template name

ACS-ECS-BulkyModifyInstanceMaintenanceAttributes

Execute Now

Template description

Modifies the maintenance settings of multiple Elastic Compute Service (ECS) instances at a time.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Type	Required	Default value	Limit
targets	The ECS instance whose maintenance settings you want to modify.	Json	Yes
notifyOnMaintenance	Specifies whether to send an event notification before maintenance.	Boolean	Yes
actionOnMaintenance	The maintenance action.	String	Yes
maintenanceWindowStartTime	The start time of the maintenance window.	String	Yes
maintenanceWindowEndTime	The end time of the maintenance window.	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 Resource Access Management (RAM) role that is assumed by CloudOps Orchestration Service (OOS).	String	No	""

Output parameters

None

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:DescribeInstances",
                "ecs:ModifyInstanceMaintenanceAttributes"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

For more information, see ACS-ECS-BulkyModifyInstanceMaintenanceAttributes.yml at GitHub.

Template content

FormatVersion: OOS-2019-06-01
Description:
  name-en: ACS-ECS-BulkyModifyInstanceMaintenanceAttributes
  name-zh-cn: the description in Chinese
  en: Bulky modify instance maintenance attributes
  zh-cn: the description in Chinese
Parameters:
  regionId:
    Label:
      en: RegionId
      zh-cn: the description in Chinese
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  targets:
    Type: Json
    Label:
      en: TargetInstance
      zh-cn: the description in Chinese
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: 'ALIYUN::ECS::Instance'
      RegionId: regionId
  notifyOnMaintenance:
    Label:
      en: NotifyOnMaintenance
      zh-cn: the description in Chinese
    Type: Boolean
  actionOnMaintenance:
    Label:
      en: ActionOnMaintenance
      zh-cn: the description in Chinese
    Type: String
    AssociationPropertyMetadata:
      ValueLabelMapping:
        Stop: stops the ECS instance.
        AutoRecover: automatically restores the ECS instance.
        AutoRedeploy: performs failover on the ECS instance, which may damage data disks.
    AllowedValues:
      - Stop
      - AutoRecover
      - AutoRedeploy
  maintenanceWindowStartTime:
    Label:
      en: MaintenanceWindowStartTime
      zh-cn: the description in Chinese
    Type: String
    AssociationProperty: DateTime
    AssociationPropertyMetadata:
      Format: 'HH:mm:ss'
  maintenanceWindowEndTime:
    Label:
      en: MaintenanceWindowEndTime
      zh-cn: the description in Chinese
    Type: String
    AssociationProperty: DateTime
    AssociationPropertyMetadata:
      Format: 'HH:mm:ss'
  rateControl:
    Label:
      en: RateControl
      zh-cn: the description in Chinese
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: the description in Chinese
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: getInstance
    Description:
      en: Views the ECS instances
      zh-cn: the description in Chinese
    Action: ACS::SelectTargets
    Properties:
      ResourceType: ALIYUN::ECS::Instance
      RegionId: '{{ regionId }}'
      Filters:
        - '{{ targets }}'
    Outputs:
      instanceIds:
        Type: List
        ValueSelector: Instances.Instance[].InstanceId
  - Name: modifyPostPaidInstanceSpec
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Modifies the instance maintenance attributes
      zh-cn: the description in Chinese
    Properties:
      Service: ECS
      API: ModifyInstanceMaintenanceAttributes
      Parameters:
        RegionId: '{{ regionId }}'
        InstanceId:
          - '{{ ACS::TaskLoopItem }}'
        NotifyOnMaintenance: '{{ notifyOnMaintenance }}'
        ActionOnMaintenance: '{{ actionOnMaintenance }}'
        MaintenanceWindow:
          - StartTime: '{{ maintenanceWindowStartTime }}'
            EndTime: '{{ maintenanceWindowEndTime }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ getInstance.instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - notifyOnMaintenance
          - actionOnMaintenance
          - maintenanceWindowStartTime
          - maintenanceWindowEndTime
        Label:
          default:
            zh-cn: the description in Chinese
            en: Configure Parameters
      - Parameters:
          - regionId
          - targets
        Label:
          default:
            zh-cn: the description in Chinese
            en: Select Ecs Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: the description in Chinese
            en: Control Options