Loading TOC...
JavaScript admin.groupSetS3ServerSideEncryption

MarkLogic Server 11.0 Product Documentation
admin:group-set-s3-server-side-encryption

admin:group-set-s3-server-side-encryption(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $protocol as xs:string
) as element(configuration)

Summary

This function gets the method of server side encryption for data at rest on the simple storage service.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-id The ID of the group. Typically, this is the result of an admin:group-get-id call.
protocol A string specifying the method of server side encryption for data at rest on the simple storage service. The choices are "none", "aes256" and "aws:kms". The default is "aes256". To specify server side encryption for data at rest on the simple storage service, choose "aes256" or "aws:kms".

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/group-security

http://marklogic.com/xdmp/privileges/admin/group-security/{id}

Usage Notes

"aws:kms" server side encryption must be used with "https" protocol.

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
		  at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $groupid := admin:group-get-id($config, "Default")
  return admin:group-set-s3-server-side-encryption($config, $groupid, "aes256")

  (: 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.  :)

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.