s3generateuri()

Generates a URI endpoint pointing to the object given

Requires Extension: S3 Resource Extension

s3generateuri( bucketNameOrPath=string, objectName=string, type=string, secure=boolean, accessKeyId=string, secretAccessKey=string, host=string, timeout=number );

Returns: String

Argument Description Default
bucketNameOrPath
string, required

This can be the bucketname or simple the virtual filesystem point for the file (if object name is no defined)

Alias: bucket, bucketName, path
objectName
string, optional

Name of the object (path) within the bucket of your object to read

Alias: object, path
type
string, optional

Defines the style/type created, possible values are:

  • virtualhost
  • path
  • arn
  • s3

For more details, please see:

Methods for accessing a bucket Amazon Resource Names (ARNs)

Alias: style

virtualhost
secure
boolean, optional

Should a secure URL (https) be created or not. Only applies to type virtualhost and path.

Alias: secured

true
accessKeyId
string, optional

S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].

Alias: accessKey, awsAccessKeyId, awsAccessKey
secretAccessKey
string, optional

S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].

Alias: secretkey, awsSecretkey, awsSecretAccessKey
host
string, optional

the provider to connect, if not set Amazon AWS is used.

Alias: provider, server
timeout
number, optional

timeout for this execution

10000

Examples

There are currently no examples for this function 18,105ms WARN No examples for function s3generateuri

See also