ACS-ECS-BulkyModifyInstanceMaintenanceAttributes - CloudOps Orchestration Service

Template name

ACS-ECS-BulkyModifyInstanceMaintenanceAttributes modifies the maintenance attributes of multiple instances in a batch.

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	Target instance	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	Task execution concurrency	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"
        },
        {
            "Action": [
                "oos:GetApplicationGroup"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

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: Batch modify the maintenance attributes of instances
  en: Bulky modify instance maintenance attributes
  zh-cn: Batch modify the maintenance attributes of instances
Parameters:
  regionId:
    Label:
      en: RegionId
      zh-cn: Region ID
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  targets:
    Type: Json
    Label:
      en: TargetInstance
      zh-cn: Target Instance
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: 'ALIYUN::ECS::Instance'
      RegionId: regionId
  notifyOnMaintenance:
    Label:
      en: NotifyOnMaintenance
      zh-cn: Specifies whether to send an event notification before the instance is down for maintenance.
    Type: Boolean
  actionOnMaintenance:
    Label:
      en: ActionOnMaintenance
      zh-cn: Maintenance Action
    Type: String
    AssociationPropertyMetadata:
      ValueLabelMapping:
        Stop: The instance is stopped (down).
        AutoRecover: The instance is automatically recovered.
        AutoRedeploy: The instance is migrated when it is down. Data on the data disks may be lost.
    AllowedValues:
      - Stop
      - AutoRecover
      - AutoRedeploy
  maintenanceWindowStartTime:
    Label:
      en: MaintenanceWindowStartTime
      zh-cn: Start time of the maintenance window.
    Type: String
    AssociationProperty: DateTime
    AssociationPropertyMetadata:
      Format: 'HH:mm:ss'
  maintenanceWindowEndTime:
    Label:
      en: MaintenanceWindowEndTime
      zh-cn: End time of the maintenance window.
    Type: String
    AssociationProperty: DateTime
    AssociationPropertyMetadata:
      Format: 'HH:mm:ss'
  rateControl:
    Label:
      en: RateControl
      zh-cn: Concurrency rate for task execution.
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: The RAM role to be assumed by OOS.
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: getInstance
    Description:
      en: Views the ECS instances
      zh-cn: Retrieves the ECS instances.
    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: Modifies the maintenance attributes of the instance.
    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: Configure Parameters
            en: Configure Parameters
      - Parameters:
          - regionId
          - targets
        Label:
          default:
            zh-cn: Select Instances
            en: Select Ecs Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: Control Options
            en: Control Options