すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::ECS::SSHKeyPair

最終更新日:Apr 09, 2025

ALIYUN::ECS::SSHKeyPair は、既存の SSH キーペアをインポートするか、新規に作成するために使用します。

構文

{
  "Type": "ALIYUN::ECS::SSHKeyPair",
  "Properties": {
    "ResourceGroupId": String, // リソースグループ ID
    "KeyPairName": String, // キーペア名
    "PublicKeyBody": String, // 公開鍵の内容
    "Tags": List // タグ
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

ResourceGroupId

String

いいえ

はい

キーペアが属するリソースグループの ID。

なし。

KeyPairName

String

はい

いいえ

キーペアの名前。

名前は 2 ~ 128 文字で、文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。文字で始まり、http:// または https:// で始めることはできません。

PublicKeyBody

String

いいえ

いいえ

キーペアの公開鍵。

このプロパティは、既存のキーペアをインポートする場合にのみ指定する必要があります。

Tags

List

いいえ

はい

タグ。

最大 20 個のタグを追加できます。

詳細については、「タグのプロパティ」をご参照ください。

タグの構文

"Tags": [
  {
    "Key": String, // タグのキー
    "Value": String // タグの値
  }
]  

タグのプロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Key

String

はい

いいえ

タグのキー。

キーは 1 ~ 128 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。

Value

String

いいえ

いいえ

タグの値。

値は最大 128 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。

戻り値

Fn::GetAtt

  • KeyPairFingerPrint: キーペアのフィンガープリント。メッセージダイジェストアルゴリズム 5 (MD5) は、Request for Comments (RFC) 4716 で定義されている公開鍵のフィンガープリント形式に基づいて使用されます。

  • PrivateKeyBody: キーペアの秘密鍵。PKCS#8 形式の暗号化されていない PEM エンコードの RSA 秘密鍵のコンテンツです。秘密鍵は、キーペアが初めて作成されたときにのみ取得できます。既存の公開鍵をインポートする場合、秘密鍵情報は使用できません。

  • KeyPairName: キーペアの名前。

  • Arn: Alibaba Cloud リソースネーム (ARN)。

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  SSHKeyPair:
    Type: ALIYUN::ECS::SSHKeyPair
    Properties:
      KeyPairName:
        Fn::Sub: ess-${ALIYUN::StackId}
Outputs:
  KeyPairFingerPrint:
    Description: 'キーペアのフィンガープリント。RFC4716 で定義されている公開鍵のフィンガープリント形式: MD5 メッセージダイジェストアルゴリズム。' # キーペアのフィンガープリント。RFC4716 で定義されている公開鍵のフィンガープリント形式: MD5 メッセージダイジェストアルゴリズム。
    Value:
      Fn::GetAtt:
        - SSHKeyPair
        - KeyPairFingerPrint
  KeyPairName:
    Description: 'SSH キーペア名。' # SSH キーペア名。
    Value:
      Fn::GetAtt:
        - SSHKeyPair
        - KeyPairName
  PrivateKeyBody:
    Description: 'キーペアの秘密鍵。暗号化されていない PEM エンコードの PKCS#8 形式の RSA 秘密鍵のコンテンツ。参照: https://www.openssl.org/docs/apps/pkcs8.html。ユーザーは、SSH キーペアが作成された場合にのみ、秘密鍵を 1 回だけ取得できます。' # キーペアの秘密鍵。暗号化されていない PEM エンコードの PKCS#8 形式の RSA 秘密鍵のコンテンツ。参照: https://www.openssl.org/docs/apps/pkcs8.html。ユーザーは、SSH キーペアが作成された場合にのみ、秘密鍵を 1 回だけ取得できます。
    Value:
      Fn::GetAtt:
        - SSHKeyPair
        - PrivateKeyBody
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "SSHKeyPair": {
      "Type": "ALIYUN::ECS::SSHKeyPair",
      "Properties": {
        "KeyPairName": {
          "Fn::Sub": "ess-${ALIYUN::StackId}"
        }
      }
    }
  },
  "Outputs": {
    "KeyPairFingerPrint": {
      "Description": "キーペアのフィンガープリント。RFC4716 で定義されている公開鍵のフィンガープリント形式: MD5 メッセージダイジェストアルゴリズム。", // キーペアのフィンガープリント。RFC4716 で定義されている公開鍵のフィンガープリント形式: MD5 メッセージダイジェストアルゴリズム。
      "Value": {
        "Fn::GetAtt": [
          "SSHKeyPair",
          "KeyPairFingerPrint"
        ]
      }
    },
    "KeyPairName": {
      "Description": "SSH キーペア名。", // SSH キーペア名。
      "Value": {
        "Fn::GetAtt": [
          "SSHKeyPair",
          "KeyPairName"
        ]
      }
    },
    "PrivateKeyBody": {
      "Description": "キーペアの秘密鍵。暗号化されていない PEM エンコードの PKCS#8 形式の RSA 秘密鍵のコンテンツ。参照: https://www.openssl.org/docs/apps/pkcs8.html。ユーザーは、SSH キーペアが作成された場合にのみ、秘密鍵を 1 回だけ取得できます。", // キーペアの秘密鍵。暗号化されていない PEM エンコードの PKCS#8 形式の RSA 秘密鍵のコンテンツ。参照: https://www.openssl.org/docs/apps/pkcs8.html。ユーザーは、SSH キーペアが作成された場合にのみ、秘密鍵を 1 回だけ取得できます。
      "Value": {
        "Fn::GetAtt": [
          "SSHKeyPair",
          "PrivateKeyBody"
        ]
      }
    }
  }
}

詳細については、「YAML の例」をご参照ください。