JavaScript admin.clusterSetExternalDataEncryptionKeyId

MarkLogic 12 Product Documentation
admin:cluster-set-external-data-encryption-key-id

admin:cluster-set-external-data-encryption-key-id(
   $config as element(configuration),
   $external-data-encryption-key-id as xs:string
) as element(configuration)

Summary

This function sets the encryption key ID to use for encryption of data when the kms-type is external.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
external-data-encryption-key-id	An string identifying the encryption key at the KMS that should be used to encrypt user data. The string must be a URN representation of a UUID as defined by RFC4122: http://www.ietf.org/rfc/rfc4122.txt Example URN: 06ea22c9-b972-4652-8d0f-9e58c62e0f7f

Required Privileges

http://marklogic.com/xdmp/privileges/admin/cluster

Example


xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin" at "/MarkLogic/admin.xqy";

let $config := admin:get-configuration()
return
  admin:cluster-set-external-data-encryption-key-id($config, "c5c37ee2-31f4-4bba-ab8e-98352f900a17")

  (: returns the new configuration element -- use admin:save-configuration to save
  the changes to the configuration or pass the configuration to other Admin API
  functions to make other changes.  :)

MarkLogic 12 Product Documentationadmin:cluster-set-external-data-encryption-key-id

Summary

Required Privileges

Example

MarkLogic 12 Product Documentation
admin:cluster-set-external-data-encryption-key-id