ACS-ESS-LifeCycleRunCommand.yml

FormatVersion: OOS-2019-06-01
Description:
  en: Use lifecycleHook to run command in the specified scaling activity instance.
  zh-cn: 使用生命周期挂钩到实例中执行命令。
  name-en: ACS-ESS-LifeCycleRunCommand
  name-zh-cn: 使用生命周期挂钩到实例中执行命令
  categories:
    - elastic_manage
Parameters:
  commandType:
    Description:
      name-en: commandType
      name-zh-cn: 云助手命令类型
      en: The type of command.
      zh-cn: 云助手命令类型。
    Type: String
    AllowedValues:
      - RunBatScript
      - RunPowerShellScript
      - RunShellScript
    Default: RunShellScript
  commandContent:
    Description:
      name-en: commandContent
      name-zh-cn: 云助手命令
      en: Command content to run in ECS instance.
      zh-cn: 在ECS实例中执行的云助手命令。
    Type: String
    AssociationProperty: Code
    Default: echo hello
  regionId:
    Description:
      name-en: regionId
      name-zh-cn: 地域ID
      en: The ID of region.
      zh-cn: '地域ID，请使用弹性伸缩系统默认值 ${regionId}'
    Type: String
    Default: '${regionId}'
  instanceIds:
    Description:
      name-en: instanceIds
      name-zh-cn: ECS实例ID列表
      en: The ID list of the ECS instance.
      zh-cn: 'ECS实例ID列表,请使用弹性伸缩系统默认值 ["${instanceId}"]'
    Type: List
    Default:
      - '${instanceIds}'
  lifecycleHookId:
    Description:
      name-en: lifecycleHookId
      name-zh-cn: 生命周期挂钩ID
      en: The ID of the lifecycle hook.
      zh-cn: '生命周期挂钩ID,请使用弹性伸缩系统默认值 ${lifecycleHookId}'
    Type: String
    Default: '${lifecycleHookId}'
  lifecycleActionToken:
    Description:
      name-en: lifecycleActionToken
      name-zh-cn: 实例关联的特定伸缩活动的令牌
      en: The token that indicates a specific scaling activity associated with an instance.
      zh-cn: '实例关联的特定伸缩活动的令牌,请使用弹性伸缩系统默认值 ${lifecycleActionToken}'
    Type: String
    Default: '${lifecycleActionToken}'
  rateControl:
    Description:
      name-en: rateControl
      name-zh-cn: 速率控制
      en: Concurrency ratio of task execution.
      zh-cn: 任务执行的并发比率。
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Description:
      name-en: OOSAssumeRole
      name-zh-cn: OOS扮演的RAM角色
      en: The RAM role to be assumed by OOS.
      zh-cn: OOS扮演的RAM角色。
    Type: String
    Default: OOSServiceRole
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: runCommand
    Action: ACS::ECS::RunCommand
    OnError: CompleteLifecycleActionForAbandon
    OnSuccess: CompleteLifecycleActionForContinue
    Description:
      en: Execute cloud assistant command.
      zh-cn: 执行云助手命令。
    Properties:
      regionId: '{{ regionId }}'
      commandContent: '{{ commandContent }}'
      instanceId: '{{ ACS::TaskLoopItem }}'
      commandType: '{{ commandType }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ instanceIds }}'
      Outputs:
        commandOutputs:
          AggregateType: Fn::ListJoin
          AggregateField: commandOutput
    Outputs:
      commandOutput:
        Type: String
        ValueSelector: invocationOutput
  - Name: CompleteLifecycleActionForContinue
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Modify lifecycle action for continue.
      zh-cn: 修改伸缩活动的等待状态为继续完成。
    OnSuccess: 'ACS::END'
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ regionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: CONTINUE
  - Name: CompleteLifecycleActionForAbandon
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Complete lifecycle action for Abandon.
      zh-cn: 修改伸缩活动的等待状态为弃用。
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ regionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: ABANDON
Outputs:
  commandOutputs:
    Type: List
    Value: '{{ runCommand.commandOutputs }}'