UseVirtualHosting Property

Determines which style request to use.

Syntax

 amazons3.getUseVirtualHosting([callback])
 amazons3.setUseVirtualHosting( useVirtualHosting, [callback])

Default Value

FALSE

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 getUseVirtualHosting([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 setUseVirtualHosting([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

If set to true, buckets will be referenced in the request using the hosted-style request: http://yourbucket.s3.amazonaws.com/yourobject. If false (default), the class will use the path-style request: http://s3.amazonaws.com/yourbucket/yourobject. This must be set to true when LocationConstraint is true.

NOTE: When set to true, there are more limitations when choosing a bucket name due to DNS server naming restrictions. See Amazon's documentation for more detailed naming information.

This property is not available at design time.

Data Type

Boolean