XQuery admin:group-set-s3-server-side-encryption

MarkLogic Server 11.0 Product Documentation
admin.groupSetS3ServerSideEncryption

admin.groupSetS3ServerSideEncryption(
   config as element(configuration),
   group-id as (Number|String),
   protocol as 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

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const groupid = admin.groupGetId(config, "Default")
  admin.groupSetS3ServerSideEncryption(config, groupid, "aes256")

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.

MarkLogic Server 11.0 Product Documentationadmin.groupSetS3ServerSideEncryption

Summary

Required Privileges

Usage Notes

Example

MarkLogic Server 11.0 Product Documentation
admin.groupSetS3ServerSideEncryption