DATASOURCE::ECS::KeyPairs

DATASOURCE::ECS::KeyPairs类型用于查询一个或多个密钥对。

语法

{
  "Type": "DATASOURCE::ECS::KeyPairs",
  "Properties": {
    "KeyPairFingerPrint": String,
    "KeyPairName": String,
    "ResourceGroupId": String,
    "Tags": List,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

KeyPairFingerPrint

String

密钥对的指纹。

根据RFC4716定义的公钥指纹格式,采用MD5信息摘要算法。

KeyPairName

String

密钥对名称。

支持正则表达式模糊搜索,使用*匹配子表达式,取值示例:

  • *SshKey:查询以SshKey结尾的密钥对名称,包括SshKey。

  • SshKey*:查询以SshKey开头的密钥对名称,包括SshKey。

  • *SshKey*:查询名称中间有SshKey的密钥对,包括SshKey。

  • SshKey:精确匹配SshKey。

ResourceGroupId

String

密钥对所在的资源组ID。

Tags

List

密钥对的标签。

最多支持20个标签。

更多信息,请参见Tags属性

RefreshOptions

String

当资源栈更新时,数据源资源的刷新策略。

有效值:

  • Never(默认值):更新堆栈时,从不刷新数据源资源。

  • Always:更新堆栈时,始终刷新数据源资源。

Tags语法

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags属性

属性名称

类型

必须

允许更新

描述

约束

Value

String

密钥对的标签值。

长度为0~128个字符,不能以aliyunacs:开头,不能包含http://https://

Key

String

密钥对的标签键。

长度为1~128个字符,不能以aliyunacs:开头,不能包含http://https://

返回数据(Fn::GetAtt)

  • KeyPairNames:密钥对名称列表。

  • KeyPairs:密钥对详情列表。

属性名称

类型

描述

约束

KeyPairNames

List

密钥对名称列表。

KeyPairs

List

密钥对详情列表。

KeyPairName

String

密钥对的名称。

取值示例:testKeyPairName。

KeyPairFingerPrint

String

密钥对的指纹。

取值示例:ABC1234567。

ResourceGroupId

String

资源组ID。

取值示例:rg-amnhr7u7c7hj****。

Tags

List

密钥对的标签。

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "KeyPairName": {
      "Type": "String",
      "Description": "The name of the key pair. You can use the asterisk (*) symbol as a wildcard in regular expressions to query key pairs by performing a fuzzy search. Sample patterns:\n*SshKey: queries key pairs whose names end with SshKey, including the key pair named SshKey.\nSshKey*: queries key pairs whose names start with SshKey, including the key pair named SshKey.\n*SshKey*: queries key pairs whose names include SshKey, including the key pair named SshKey.\nSshKey: queries the key pair named SshKey."
    }
  },
  "Resources": {
    "KeyPairs": {
      "Type": "DATASOURCE::ECS::KeyPairs",
      "Properties": {
        "KeyPairName": {
          "Ref": "KeyPairName"
        }
      }
    }
  },
  "Outputs": {
    "KeyPairs": {
      "Value": {
        "Fn::GetAtt": [
          "KeyPairs",
          "KeyPairs"
        ]
      }
    },
    "KeyPairNames": {
      "Value": {
        "Fn::GetAtt": [
          "KeyPairs",
          "KeyPairNames"
        ]
      }
    }
  }
}