Build Status

Welcome to the Amazon S3 SDK

This SDK allows you to add Amazon S3 capabilities to your ColdFusion (CFML) applications. It is also a ColdBox Module, so if you are using ColdBox, you get auto-registration and much more.

Resources

  • Source: https://github.com/coldbox-modules/s3sdk
  • Issues: https://github.com/coldbox-modules/s3sdk/issues
  • Changelog
  • S3 API Reference: http://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html

Installation

This SDK can be installed as standalone or as a ColdBox Module. Either approach requires a simple CommandBox command:

box install s3sdk

Then follow either the standalone or module instructions below.

Standalone

This SDK will be installed into a directory called s3sdk and then the SDK can be instantiated via new s3sdk.models.AmazonS3() with the following constructor arguments:

<cfargument name="accessKey" 			required="true">
<cfargument name="secretKey" 			required="true">
<cfargument name="encryption_charset" 	required="false" default="utf-8">
<cfargument name="ssl" 					required="false" default="false">
<cfargument name="awsregion" 			required="false" default="us-east-1">

ColdBox Module

This package also is a ColdBox module as well. The module can be configured by creating an s3sdk configuration structure in your moduleSettings struct in the application configuration file: config/Coldbox.cfc with the following settings:

moduleSettings = {
	s3sdk = {
		// Your amazon access key
		accessKey = "",
		// Your amazon secret key
		secretKey = "",
		// The default encryption character set
		encryption_charset = "utf-8",
		// SSL mode or not on cfhttp calls.
		ssl = false,
		// Your AWS Region.
		awsregion = "us-east-1"
	}
};

Then you can leverage the SDK CFC via the injection DSL: [email protected]

Usage

Please check out the api docs: https://apidocs.ortussolutions.com/#/coldbox-modules/s3sdk/

Changelog

v4.0.1

  • Fixes to models location, oopsy!

v4.0.0

  • AWS Region Support
  • Migrated Module Layout to use Ortus Standard Module Layout
  • Added testing for all ACF Engines
  • Rework as generic Box module (compatibility change), you must move your s3sdk top level settings in ColdBox Config to moduleSettings.s3sdk
  • deleteBucket() returns false if bucket doesn't exist instead of throwing an exception
  • Few optimizations and documentation of the API

v3.0.1

  • Travis Updates and self-publishing

v3.0.0

  • Ugprade to ColdBox 4 standards
  • Upgrade to latest Amazon S3 SDK standards
  • Travis build process

v2.0

  • Original Spec as a ColdBox Plugin

 

 
$ box install s3sdk
No collaborators yet.
5.00 / 3
  • Nov 25 2009 03:34 AM
  • Oct 22 2018 10:09 PM
  • 11759
  • 10774
  • 1027