KeyOrigin Property

The origin of the CMK's key material.

Syntax

 amazonkms.getKeyOrigin(index, [callback])

Possible Values

  0 (akoKMS), 
  1 (akoExternal), 
  2 (akoCloudHSM)

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 getKeyOrigin([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 setKeyOrigin([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

The origin of the CMK's key material.

This property reflects the origin of the CMK's key material. Possible values are:

• akoKMS (0): Key material from Amazon KMS. (Also the default value used when ListKeys is called.)
• akoExternal (1): External key material imported into Amazon KMS.
• akoCloudHSM (2): Key material from an Amazon CloudHSM cluster.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Integer