ACS::ECS::StopInstance.yml

FormatVersion: OOS-2019-06-01
Description:
  name-en: ACS::ECS::StopInstance
  name-zh-cn: 停止实例(ECS)
  en: Stops an ECS instance
  zh-cn: 停止一台ECS实例.
Parameters:
  regionId:
    Label:
      en: RegionId
      zh-cn: 地域ID
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
    Default: '{{ ACS::RegionId }}'
  instanceId:
    Label:
      en: ECSInstanceId
      zh-cn: ECS实例ID
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: regionId
  stoppedMode:
    Label:
      en: StoppedMode
      zh-cn: 停止模式
    Description:
      en: About StoppedMode details please refer to <a href="https://help.aliyun.com/document_detail/25501.html" target="_blank">document</a>
      zh-cn: 停止按量付费ECS实例后，是否继续计费，有关StoppedMode详情请<a href="https://help.aliyun.com/document_detail/25501.html" target="_blank">参考</a>
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::StopMode
    Default: ''
  hibernate:
    Label:
      en: WhetherHibernateInstance
      zh-cn: 实例是否休眠
    Type: Boolean
    Default: false
  forceStop:
    Label:
      en: ForceStop
      zh-cn: 是否强制关机
    Type: Boolean
    Default: false
Tasks:
- Name: getInstanceStatus
  Description:
    en: Queries the ECS instances status
    zh-cn: 获取ECS实例的状态
  Action: ACS::ExecuteApi
  Properties:
    Service: ECS
    API: DescribeInstances
    Parameters:
      RegionId: '{{ regionId }}'
      InstanceIds:
        - '{{ instanceId }}'
  Outputs:
    status:
      Type: String
      ValueSelector: Instances.Instance[].Status
- Name: whetherInstanceIsStopped
  Action: 'ACS::Choice'
  Description:
    en: Choose next task by instance Stopped status
    zh-cn: 根据实例的已停止状态选择下一个任务
  Properties:
    DefaultTask: whetherInstanceIsStopping
    Choices:
      - When:
          'Fn::Equals':
            - Stopped
            - '{{ getInstanceStatus.status }}'
        NextTask: 'ACS::END'
- Name: whetherInstanceIsStopping
  Action: 'ACS::Choice'
  Description:
    en: Choose next task by instance Stopping status
    zh-cn: 根据实例的停止中状态选择下一个任务
  Properties:
    DefaultTask: stopInstance
    Choices:
      - When:
          'Fn::Equals':
            - Stopping
            - '{{ getInstanceStatus.status }}'
        NextTask: untilInstanceReady
- Name: stopInstance
  Action: ACS::ExecuteAPI
  Description:
    en: Stops ECS instance
    zh-cn: 停止ECS实例
  Properties:
    Service: ECS
    API: StopInstance
    Parameters:
      RegionId: '{{ regionId }}'
      InstanceId: '{{ instanceId }}'
      StoppedMode: '{{ stoppedMode }}'
      Hibernate: '{{ hibernate }}'
      ForceStop: '{{ forceStop }}'
- Name: untilInstanceReady
  Action: ACS::WaitFor
  Description:
    en: Waits for the ECS instance to enter Stopped status
    zh-cn: 等待ECS实例至已停止状态
  Properties:
    Service: ECS
    API: DescribeInstances
    Parameters:
      RegionId: '{{ regionId }}'
      InstanceIds:
      - '{{ instanceId }}'
    DesiredValues:
    - Stopped
    PropertySelector: Instances.Instance[].Status