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
|
|
expireDate
datetime,
optional
|
Date time when the URL should expire.
Alias:
expire
|
|
httpMethod
string,
optional
|
The desired HTTP method (e.g., GET, PUT). Defaults to GET.
Alias:
method
|
|
sseAlgorithm
string,
optional
|
The desired server-side encryption algorithm, valid values are AES256 or KMS.
Alias:
algorithm
|
|
sseCustomerKey
string,
optional
|
The server-side encryption customer-provided key.
Alias:
customerKey
|
|
checksum
string,
optional
|
The base64 encoded MD5 checksum of the object's content.
Alias:
contentMd5
|
|
type
string,
optional
|
The MIME type of the object (e.g., "text/plain").
Alias:
contentType
|
|
disposition
string,
optional
|
Specifies presentational information for the object, like "attachment; filename="filename.pdf"".
Alias:
contentDisposition
|
|
encoding
string,
optional
|
Specifies content encodings applied to the object, like gzip.
Alias:
contentEncoding
|
|
version
string,
optional
|
The version ID of the object if versioning is enabled.
Alias:
versionId
|
|
zeroByte
boolean,
optional
|
A flag to specify if the object has zero-byte content.
Alias:
zeroByteContent
|
|
struct,
optional
|
Struct of custom response headers for custom metadata prefixed with "x-amz-meta-" (prefix is optional, function will add it if missed).
Alias:
customResponseHeaders
|
|
accessKeyId
string,
optional
|
S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].
Alias:
accessKey
|
|
secretAccessKey
string,
optional
|
S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].
Alias:
secretkey
|
|
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
|