ALIYUN::ECS::SSHKeyPair - Resource Types| Alibaba Cloud Documentation Center

Creates a new pair of SSH keys, or imports an existing public key to ECS.

Syntax

{
    "Type" : "ALIYUN::ECS::SSHKeyPair",
    "Properties" : {
         "PublicKeyBody" : String,
         "KeyPairName" : String
    }
}

Properties

Name	Type	Required	Description	Constraints
KeyPairName	String	Yes	Globally unique name of the SSH key pair.	It can contain 2 to 128 characters. It must start an English letter and can contain English letters, numbers, periods(.), underscores(_), and hyphens(-). It cannot start with “http://“ or “https://“.
PublicKeyBody	String	No	The public key.	N/A

Return values

Fn::GetAtt

KeyPairFingerPrint: Public key fingerprint. It is a short sequence of bytes used to identify a longer public key. Fingerprints are created by applying a cryptographic hash function to a public key.
PrivateKeyBody: Private key of the key pair. RSA private key content of the unencrypted PEM code in PKCS#8 format. You must save and secure the private key file at the time of its creation. If you import an existing public key, no private key information will be available.
KeyPairName: Globally unique name of the SSH key pair.

Examples

{
  "ROSTemplateFormatVersion" : "2015-09-01",
  "Resources" : {
    "SSHKeyPair": {
      "Type": "ALIYUN::ECS::SSHKeyPair",
      "Properties": {
        "KeyPairName" : "ssh_key_pair_v1",
      }
    }
  },
  "Outputs": {
    "KeyPairName": {
         "Value" : {"Fn::GetAtt": ["SSHKeyPair","KeyPairName"]}
    },
    "PrivateKeyBody": {
         "Value" : {"Fn::GetAtt": ["SSHKeyPair","PrivateKeyBody"]}
    },
    "KeyPairFingerPrint": {
         "Value" : {"Fn::GetAtt": ["SSHKeyPair","KeyPairFingerPrint"]}
    }
  }
}