ACS-ECS-BulkyLeaveSecurityGroup - CloudOps Orchestration Service

Template name

ACS-ECS-BulkyLeaveSecurityGroup removes a batch of ECS instances from a specified security group.

Execute Now

Template description

Removes multiple Elastic Compute Service (ECS) instances from a specific security group.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Type	Required	Default value	Limit
securityGroupId	The security group ID.	String	Yes
targets	Target instance	Json	Yes
rateControl	Concurrent task execution rate	Json	Yes
regionId	The region ID.	String	No	{{ ACS::RegionId }}
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:LeaveSecurityGroup"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "oos:GetApplicationGroup"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

Details for ACS-ECS-BulkyLeaveSecurityGroup

Template content

FormatVersion: OOS-2019-06-01
Description:
  name-en: ACS-ECS-BulkyLeaveSecurityGroup
  name-zh-cn: Removes multiple ECS instances from a specified security group
  en: Bulky leave security group
  zh-cn: Removes multiple ECS instances from a specified security group
Parameters:
  regionId:
    Label:
      en: RegionId
      zh-cn: Region ID
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
    Default: '{{ ACS::RegionId }}'
  securityGroupId:
    Label:
      en: SecurityGroupId
      zh-cn: Security Group ID
    Type: String
    AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
    AssociationPropertyMetadata:
      RegionId: regionId
  targets:
    Type: Json
    Label:
      en: TargetInstance
      zh-cn: Target Instance
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: 'ALIYUN::ECS::Instance'
      RegionId: regionId
      Status: Running
  rateControl:
    Label:
      en: RateControl
      zh-cn: The concurrency rate for task execution
    Type: Json
    AssociationProperty: RateControl
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: The RAM role that OOS assumes
    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: leaveSecurityGroup
    Action: ACS::ExecuteAPI
    Description:
      en: Leave security group
      zh-cn: Removes the instance from the security group
    Properties:
      Service: ECS
      API: LeaveSecurityGroup
      Parameters:
        RegionId: '{{ regionId }}'
        InstanceId: '{{ ACS::TaskLoopItem }}'
        SecurityGroupId: '{{ securityGroupId }}'
    Loop:
      Items: '{{ getInstance.instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - targets
          - securityGroupId
        Label:
          default:
            zh-cn: Select Instances
            en: Select Ecs Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: Advanced Options
            en: Control Options