Loading TOC...
JavaScript admin.groupSetS3Protocol

MarkLogic 12 EA 2 Product Documentation
admin:group-set-s3-protocol

admin:group-set-s3-protocol(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $protocol as xs: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


  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-protocol($config, $groupid, "https")

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