Key Property

The Keys to use while launching an instance from StartInstance .

Syntax

 ec2.getKey(index, [callback])
 ec2.setKey(index,  key, [callback])

Default Value

"0"

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 the getKey([callback]) 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.

The callback for the setKey([callback]) method is defined as:

function(err){ }

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

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Defining keys in this collection allows the user to define the Keys that have access to an instance when calling StartInstance.

This property is not available at design time.

Data Type

String