s3Read

Reads an object from an S3 bucket as a string.

s3Read(bucketName, objectName [, charset, accessKeyId, secretAccessKey, host, timeout]) → returns string

Argument Reference

bucketName string
Required

The bucket name.

objectName string
Required

The object key.

charset string
Default: UTF-8

The charset of the content.

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. Doesn't list timeout.

Examples
Sample code invoking the s3Read function

Reads the body of an object from a bucket.

content = s3Read("my-bucket", "logs/today.txt");

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

Fork me on GitHub