Loading TOC...

admin.groupSetS3Protocol

admin.groupSetS3Protocol(
   $config as element(configuration),
   $group-id as (Number|String),
   $protocol as String
) as element(configuration)

Summary

This function sets the simple storage service protocol for hosts in the group.

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 protocol to use when accessing the simple storage service. The choices are "http" and "https". The default is "http". To use a more secure protocol when accessing the simple storage service, choose "https".

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}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var groupid = admin.groupGetId(config, "Default")
  admin.groupSetS3Protocol(config, groupid, "https")

   //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.  
    

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