文档

ALIYUN::ECS::SSHKeyPairAttachment

更新时间:

ALIYUN::ECS::SSHKeyPairAttachment类型用于绑定SSH密钥对到ECS实例。

语法

{
  "Type": "ALIYUN::ECS::SSHKeyPairAttachment",
  "Properties": {
    "InstanceIds": List,
    "KeyPairName": String,
    "AutoReboot": Boolean
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

InstanceIds

List

要绑定的ECS实例ID列表。

ID之间用英文逗号(,)分隔。 只支持Linux系统实例。

KeyPairName

String

SSH密钥对的名称 。

AutoReboot

Boolean

如果实例处于运行状态,是否需要重启实例使ssh密钥生效。

取值:

  • true:重启实例。

  • false(默认值):不重启实例。

返回值

Fn::GetAtt

无。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  InstanceId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
Resources:
  SSHKeyPairAttachment:
    Type: ALIYUN::ECS::SSHKeyPairAttachment
    Properties:
      KeyPairName: ssh_key_pai****
      InstanceIds:
        - Ref: InstanceId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "InstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  },
  "Resources": {
    "SSHKeyPairAttachment": {
      "Type": "ALIYUN::ECS::SSHKeyPairAttachment",
      "Properties": {
        "KeyPairName": "ssh_key_pai****",
        "InstanceIds": [
          {
            "Ref": "InstanceId"
          }
        ]
      }
    }
  }
}