Cloud Keys 2020 Node.js Edition

Questions / Feedback?

KeyTemplateProtectionLevel Property

The protection level to use when new versions of the key are created.

Syntax

 googlekms.getKeyTemplateProtectionLevel(index, [callback])

Default Value

""

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 getKeyTemplateProtectionLevel([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 setKeyTemplateProtectionLevel([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 protection level to use when new versions of the key are created.

This property reflects the protection level to use when new versions of the key are created by CreateVersion. Possible values are:

  • SOFTWARE
  • HSM
  • EXTERNAL

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

String

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Node.js Edition - Version 20.0 [Build 8157]