All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ECS-BulkyAttachInstanceRamRole

Last Updated:Sep 20, 2024

Template name

ACS-ECS-BulkyAttachInstanceRamRole

Execute Now

Template description

Attaches a Resource Access Management (RAM) role to multiple Elastic Compute Service (ECS) instances at a time.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Type

Required

Default value

Limit

RamRoleName

The name of the RAM role.

String

Yes

targets

The ECS instances to which you want to attach the RAM role.

Json

Yes

regionId

The region ID.

String

No

{{ ACS::RegionId }}

rateControl

The rate control settings.

Json

No

{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}

OOSAssumeRole

The RAM role that is assumed by CloudOps Orchestration Service (OOS).

String

No

""

Output parameters

Parameter

Description

Type

instanceIds

List

Permission policy that is required to execute the template

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

References

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

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Bulky attaches instance ram role
  zh-cn: the description in Chinese
  name-en: ACS-ECS-BulkyAttachInstanceRamRole
  name-zh-cn: the description in Chinese
  categories:
    - instance_manage
Parameters:
  regionId:
    Type: String
    Label:
      en: RegionId
      zh-cn: the description in Chinese
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  RamRoleName:
    Label:
      en: RamRoleName
      zh-cn: the description in Chinese
    Type: String
  targets:
    Label:
      en: TargetInstance
      zh-cn: the description in Chinese
    Type: Json
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: 'ALIYUN::ECS::Instance'
      RegionId: regionId
  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:
    RegionId: '{{ regionId }}'
    ResourceType: 'ALIYUN::ECS::Instance'
    Filters:
      - '{{ targets }}'
  Outputs:
    instanceIds:
      Type: List
      ValueSelector: Instances.Instance[].InstanceId
- Name: attachInstanceRamRole
  Action: ACS::ExecuteApi
  Description:
    en: Attach instance ram role
    zh-cn: the description in Chinese
  Properties:
    Service: ECS
    API: AttachInstanceRamRole
    Parameters:
      RegionId: '{{ regionId }}'
      RamRoleName: '{{ RamRoleName }}'
      InstanceIds:
        - '{{ ACS::TaskLoopItem }}'
  Loop:
    RateControl: '{{ rateControl }}'
    Items: '{{ getInstance.instanceIds }}'
Outputs:
  instanceIds:
    Type: List
    Value: '{{ getInstance.instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - RamRoleName
        Label:
          default:
            zh-cn: the description in Chinese
            en: Configure Parameters
      - Parameters:
          - regionId
          - targets
        Label:
          default:
            zh-cn: the description in Chinese
            en: Select Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: the description in Chinese
            en: Control Options