background image

Configuration Guide

The Configuration Object

Configuration in the SDK can be done in two ways:

1. Global configuration on 

AWS.config

, or,

2. Passing extra configuration to a service object

Setting global configuration with 

AWS.config

 is often easier to get up and running with, but service level

configuration can provide much more control over your requests. Both of these configuration mechanisms
are discussed.

Global Configuration (

AWS.config

)

By default, you can set global configuration by updating the 

AWS.config

 object with new settings. The

most common settings are:

accessKeyId

secretAccessKey

sessionToken

 — for credential management

region

 — to set the region for requests

sslEnabled

 — whether SSL is enabled or not

maxRetries

 — to control the number of retries for a request

The only things you need to set in order to use the SDK are credentials and the region value. Let's discuss
how to do that.

Setting AWS Credentials

Note

Remember, if you set your AWS credentials in your environment variables, the AWS SDK for
Node.js will automatically detect them, and you will not need to perform any manual credential
configuration in your application.

Version 0.9.1-pre.2 : Preview

4

AWS SDK for Node.js Getting Started Guide

The Configuration Object

Summary of Contents for AWS SDK

Page 1: ...AWS SDK for Node js Getting Started Guide Version 0 9 1 pre 2 Preview...

Page 2: ...Amazon Web Services AWS SDK for Node js Getting Started Guide...

Page 3: ...azon Route 53 Amazon S3 Amazon VPC In addition Amazon com graphics logos page headers button icons scripts and service names are trademarks or trade dress of Amazon in the U S and or other countries A...

Page 4: ...AWS SDK for Node js 1 AWS Account and Credentials 2 Configuration Guide 4 Services 7 Making Requests 9 Examples 14 Version 0 9 1 pre 2 Preview 4 AWS SDK for Node js Getting Started Guide...

Page 5: ...g into a terminal window npm install aws sdk Note Installing the aws sdk npm package on Windows may display errors while trying to install the optional dependency for libxmljs This error can be safely...

Page 6: ...n a copy of the License at http www apache org licenses LICENSE 2 0 Unless required by applicable law or agreed to in writing software distributed under the License is distributed on an AS IS BASIS WI...

Page 7: ...r Secret Access Key click Show Your secret key must remain a secret that is known only to you and AWS Keep it confidential in order to protect your account Store it securely in a safe place and never...

Page 8: ...with new settings The most common settings are accessKeyId secretAccessKey sessionToken for credential management region to set the region for requests sslEnabled whether SSL is enabled or not maxRet...

Page 9: ...redentials in your application at all The keys that the SDK looks for are as follows AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_SESSION_TOKEN optional Alternately the SDK can accept the AMAZON_ prefi...

Page 10: ...service object constructor var ec2 new AWS EC2 region ap southeast 2 maxRetries 15 Note that the constructor takes all of the same configuration data as the AWS config object described above including...

Page 11: ...aPipeline AWS DirectConnect AWS DynamoDB AWS EC2 AWS ElastiCache AWS ElasticBeanstalk AWS ElasticTranscoder AWS ELB AWS EMR AWS Glacier AWS IAM AWS ImportExport AWS OpsWorks AWS RDS AWS Redshift AWS R...

Page 12: ...obal settings For example an EC2 object can be created for a specific region var ec2 new EC2 region us west 2 This object will continue to use the globally provided credentials Passing Arguments to a...

Page 13: ...tances function error data if error console log error an error occurred else console log data request succeeded The error and data parameters are described in the Response Object section below Note th...

Page 14: ...null if an error occurs see below The error property In the event of a service error or transfer error the response error property will be filled with the given error data in the form code SHORT_UNIQU...

Page 15: ...re passing parameters to the operation the callback should be placed after the parameters s3 client getObject Bucket bucket Key key function err data AWS Request Events You can alternatively register...

Page 16: ...id s3 client listBuckets fail function error response console log error or console log response error send Prints code Forbidden message null on complete function response The complete event triggers...

Page 17: ...e and fail Use this callback to handle any request cleanup that must be executed regardless of the success state Note that if you do intend to use response data inside of this callback you must check...

Page 18: ...S3 Amazon S3 List All of Your Buckets listBuckets The following example lists all buckets associated with your AWS account var s3 new AWS S3 s3 client listBuckets function err data for var index in d...

Page 19: ...g var file require fs createWriteStream path to file jpg s3 client getObject params createReadStream pipe file Alternatively you can register an httpData event listener on the request object to access...

Reviews: