ALIYUN::ECS::SSHKeyPair is used to create or import an SSH key pair to an ECS instance.
Syntax
{
"Type": "ALIYUN::ECS::SSHKeyPair",
"Properties": {
"ResourceGroupId": String,
"KeyPairName": String,
"PublicKeyBody": String
}
}
Properties
Name | Type | Required | Editable | Description | Validity |
---|---|---|---|---|---|
ResourceGroupId | String | No | No | The ID of the resource group to which the instance belongs. | None |
KeyPairName | String | Yes | No | The globally unique name of the SSH key pair. | The name must be 2 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter but cannot start with http:// or https://. |
PublicKeyBody | String | No | No | Specifies the SSH public key to import. | None |
Response parameters
Fn::GetAtt
- KeyPairFingerPrint: the fingerprint of the key pair. The public key fingerprint format is defined in RFC 4716 and uses the MD5 message digest algorithm.
- PrivateKeyBody: the private key of the key pair. An unencrypted RSA private key must be encoded using PEM and must be in the PKCS#8 format. The private key of a key pair can only be obtained at the time of its creation. If you import an existing public key, no private key information will be available.
- KeyPairName: the 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"
]
}
}
}
}