CloudOps Orchestration Service:ACS-ECS-BulkyAttachKeyPair

Template name

Attaches an SSH key pair to multiple ECS instances in a batch.

Execute Now

Template description

Attaches an SSH key pair to multiple 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
keyPairName	SSH key pair name.	String	Yes
regionId	Region ID.	String	No	{{ ACS::RegionId }}
rateControl	Task concurrency control	Json	No	{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}
OOSAssumeRole	The Resource Access Management (RAM) role assumed by OOS.	String	No	""

Output parameters

Parameter	Description	Type
instanceIds		List

Required permissions

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:AttachKeyPair",
                "ecs:DescribeInstances",
                "ecs:RebootInstance"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "oos:GetApplicationGroup"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

The full template YAML is available at ACS-ECS-BulkyAttachKeyPair.yml on GitHub.

Template content

FormatVersion: OOS-2019-06-01
Description:
  name-en: ACS-ECS-BulkyAttachKeyPair
  name-zh-cn: Bulky attach keypair to ECS instances
  en: Bulky attach keypair to ECS instances
  zh-cn: Bulky attach keypair to ECS instances
Parameters:
  regionId:
    Type: String
    Label:
      en: RegionId
      zh-cn: Region ID
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  targets:
    Type: Json
    Label:
      en: TargetInstance
      zh-cn: Target Instance
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: 'ALIYUN::ECS::Instance'
      RegionId: regionId
  keyPairName:
    Label:
      en: KeyPairName
      zh-cn: Key Pair Name
    Type: String
    AssociationProperty: ALIYUN::ECS::KeyPair::KeyPairName
  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 that OOS assumes
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
- Name: getInstance
  Description:
    en: Views the ECS instances
    zh-cn: Views the ECS instances
  Action: ACS::SelectTargets
  Properties:
    ResourceType: ALIYUN::ECS::Instance
    RegionId: '{{ regionId }}'
    Filters:
      - '{{ targets }}'
  Outputs:
    instanceIds:
      Type: List
      ValueSelector: Instances.Instance[].InstanceId
- Name: attachKeyPair
  Action: ACS::ECS::AttachKeyPair
  Description:
    en: Attach KeyPair to ECS instance
    zh-cn: Attach KeyPair to ECS instance
  Properties:
    regionId: '{{ regionId }}'
    instanceId: '{{ ACS::TaskLoopItem }}'
    keyPairName: '{{ keyPairName }}'
  Loop:
    RateControl: '{{ rateControl }}'
    Items: '{{ getInstance.instanceIds }}'
Outputs:
  instanceIds:
    Type: List
    Value: '{{ getInstance.instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - targets
          - keyPairName
        Label:
          default:
            zh-cn: Select ECS Instances
            en: Select Ecs Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: Control Options
            en: Control Options