s3Upload

Uploads a file to an S3 bucket.

s3Upload(bucketName, objectName, source [, acl, location, accessKeyId, secretAccessKey, host, timeout]) → returns void

Argument Reference

bucketName string
Required

The bucket name.

objectName string
Required

The object key.

source any
Required

A file path, or a file object from fileOpen().

acl any

An array of structs, one for each ACL grant.

location string

The S3 region.

accessKeyId string

The S3 access key ID. Defaults to the lucee.s3.accesskeyid system property or environment variable.

secretAccessKey string

The S3 secret access key. Defaults to the lucee.s3.secretaccesskey system property or environment variable.

host string

The hostname of an S3-compatible provider, without https://. Defaults to Amazon AWS.

timeout numeric
Default: 10000

The timeout in milliseconds.

Compatibility

Lucee:

Requires the S3 extension.

RustCFML:

Names the first two arguments bucket and object, and the secret key argument secretKey. Detects the MIME type from the object key's extension. Doesn't list timeout.

Examples
Sample code invoking the s3Upload function

Reads the local file and stores it in the bucket.

s3Upload("my-bucket", "uploads/report.pdf", expandPath("./report.pdf"));

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub