Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

Region Property

The region where the bucket is located.

Syntax

 amazons3.getRegion([callback])
 amazons3.setRegion( region, [callback])

Default Value

"us-east-1"


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getRegion([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setRegion([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

By default the class will use the US East (N. Virginia) region. Set this property if the bucket is located in a different region.

Available Regions:

ValueRegion
us-east-1 (Default)US East (N. Virginia)
us-west-1US West (N. California)
us-west-2US West (Oregon)
eu-west-1EU (Ireland)
eu-central-1EU (Frankfurt)
ap-northeast-1Asia Pacific (Tokyo)
ap-northeast-2Asia Pacific (Seoul)
ap-southeast-1Asia Pacific (Singapore)
ap-southeast-2Asia Pacific (Sydney)
sa-east-1South America (São Paulo)
cn-north-1China North

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0