AWS EC2

Create key pair

Create an ED25519 or 2048-bit RSA key pair with a name and in the PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key, or an unencrypted PPK formatted private key for use with PuTTY. If a key with the same name already exists, Amazon EC2 returns an error.

Inputs

Expand All

Field

Type

Description

region [required]

enum

default: us-east-1

keyName [required]

string

A unique name for the key pair.

keyType

enum

The type of key pair. ED25519 keys are not supported for Windows instances. Allowed enum values: rsa,ed25519

default: `rsa`

keyFormat

enum

The format of the key pair. Allowed enum values: pem,ppk

default: pem

tagSpecifications

[object]

The tags to apply to the new key pair.

ResourceType

string

The type of resource to tag on creation.

Tags

[object]

The tags to apply to the resource.

Key

string

The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

Value

string

The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Outputs

Expand All

Field

Type

Description

keyFingerprint

string

For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

keyMaterial

string

An unencrypted PEM encoded RSA or ED25519 private key.

keyName

string

The name of the key pair.

keyPairId

string

The ID of the key pair.

tags

[object]

Any tags applied to the key pair.

Key

string

The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

Value

string

The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.