CreateKeyPair Method

Creates a new key pair to use while launching Instances.

Syntax

ec2.createKeyPair(keyName, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Creates a new 2048 bit RSA key pair and returns a unique ID that can be used to reference this key pair when launching new instances.

The material for the private key will be returned from the method call. A user can use this material to save this key to a file, or pass to another program as desired.