FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...


v0.2.1 CommandBox Modules

Welcome to the Amazon Pinpoint SDK

This SDK allows you to add Amazon Pinpoint 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.



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

box install pinpointsdk

Then follow either the standalone or module instructions below.


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

 * Create a new PinPointSDK Instance
 * @accessKey The Amazon access key.
 * @secretKey The Amazon secret key.
 * @awsRegion The Amazon region. Defaults to us-east-1
 * @awsDomain The Domain used PinPoint Service ( Defaults to
 * @encryption_charset The charset for the encryption. Defaults to UTF-8.
 * @ssl True if the request should use SSL. Defaults to true.
 * @return An AmazonPinPoint instance.
public AmazonPinPoint function init(
	required string accessKey,
	required string secretKey,
	string awsRegion = "us-east-1",
	string awsDomain = "",
	string encryption_charset = "UTF-8",
	boolean ssl = true

ColdBox Module

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

moduleSettings = {
	pinpointsdk = {
		// Your amazon, digital ocean access key
		accessKey = "",
		// Your amazon, digital ocean secret key
		secretKey = "",
		// The default encryption character set: defaults to utf-8
		encryption_charset = "utf-8",
		// SSL mode or not on cfhttp calls: Defaults to true
		ssl = true,
		// Your AWS/Digital Ocean Region: Defaults to us-east-1
		awsregion = "us-east-1",
		// Your AWS/Digital Ocean Domain Mapping: defaults to
		awsDomain = ""

Then you can leverage the SDK CFC via the injection DSL: AmazonPinPoint@pinpointsdk

$ box install pinpointsdk

No collaborators yet.
  • {{ getFullDate("2020-03-22T03:13:52Z") }}
  • {{ getFullDate("2020-06-24T08:42:43Z") }}
  • 1,354
  • 1,580