s3ReadBinary

Reads an object from an S3 (or S3-compatible) bucket and returns its body as a binary value.

s3ReadBinary(bucket, object [, accessKeyId, secretKey, host]) → returns binary

This function requires RustCFML.  Not supported on Lucee, Adobe ColdFusion, etc.
  1. CFDocs
  2. Functions
  3. All CFML Functions
  4. s3ReadBinary
  5. RustCFML
  6. 0 Issue
  7. Edit
See Also:   s3read   s3write   s3download

Argument Reference

bucket string
Required

The name of the S3 bucket to read from.

object string
Required

The object key to read.

accessKeyId string

Inline AWS access key id. Overrides credentials from Application.cfc and environment variables.

secretKey string

Inline AWS secret access key.

host string

Inline endpoint URL for S3-compatible providers (e.g. Cloudflare R2, MinIO).

Examples
Sample code invoking the s3ReadBinary function

Returns the raw bytes of the object.

bytes = s3ReadBinary("my-bucket", "images/photo.jpg");

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

Fork me on GitHub