installation

Easy to install in Node.js

npm install dynasty

credentials

Amazon uses a 2 key system for access to its APIs. They are the Access Key Id and the Secret Access Key.

Simply create an object with at least these 2 keys and your specific keys as the values:

var credentials = {
    accessKeyId: '<YOUR ACCESS_KEY_ID>',
    secretAccessKey: '<YOUR_SECRET_ACCESS_KEY>'
};

Your accessKeyId and secretAccessKey can be obtained in the AWS console under the IAM (Identity Account Management) menu which has a green key as its icon.

Amazon recommends that you create a new User to limit access to DynamoDB if you haven't already.

More info on getting started with credentials

Recommend storing these credentials in environment variables and loading them in a config file.

So rather than the text strings appearing in your code (and worse, getting committed to your repo!), set them as environment variables and load them in your code as follows:

var credentials = {
    accessKeyId: process.env.AWS_ACCESS_KEY_ID,
    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
};

Can optionally specify a region. If none is specified, us-east-1 is the default.

For example, to use the eu-west-1 region based in Ireland, use the following credentials:

var credentials = {
    accessKeyId: process.env.AWS_ACCESS_KEY_ID,
    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
    region: 'eu-west-1'
};

Only this short string is necessary to specify the region, Dynasty will convert it into the full endpoint URL for you.

As of the time of this writing (August 2016), Amazon supported DynamoDB in the following regions:

key	location
us-east-1	US East (N. Virginia)
us-west-1	US West (N. California)
us-west-2	US West (Oregon)
ap-south-1	Asia Pacific (Mumbai)
ap-northeast-2	Asia Pacific (Seoul)
ap-southeast-1	Asia Pacific (Singapore)
ap-southeast-2	Asia Pacific (Sydney)
ap-northeast-1	Asia Pacific (Tokyo)
eu-central-1	EU (Frankfurt)
eu-west-1	EU (Ireland)
sa-east-1	South America (São Paulo)