IPWorks S3 2020 Node.js Edition

Questions / Feedback?

AccessPolicy Property

The canned access policy to apply to a bucket or object.

Syntax

 s3client.getAccessPolicy([callback])
 s3client.setAccessPolicy( accessPolicy, [callback])

Possible Values

  0 (ptPrivate), 
  1 (ptPublicRead), 
  2 (ptPublicReadWrite), 
  3 (ptAuthenticatedRead), 
  4 (ptBucketOwnerRead), 
  5 (ptBucketOwnerFullControl), 
  6 (ptNone)

Default Value

0

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 getAccessPolicy([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 setAccessPolicy([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

This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:

Valid values are:

ptPrivate (0) (default) Owner gets full control, no one else has access.
ptPublicRead (1) Owner gets full control, everyone else gets read access.
ptPublicReadWrite (2) Owner gets full control, everyone else gets read/write access.
ptAuthenticatedRead (3) Owner gets full control, authenticated users get read access.
ptBucketOwnerRead (4) Only applicable for objects. Object owner gets full control, bucket owner gets read access.
ptBucketOwnerFullControl (5) Only applicable for objects. Both object and bucket owner get full control.
ptNone (6) (Instructs the class to not explicitly set a canned access policy for a bucket or object.)

Note: Most S3-compatible service providers support all of the canned access policies listed above, but some do not, or have additional restrictions. Refer to a provider's documentation for more information.

Data Type

Integer

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks S3 2020 Node.js Edition - Version 20.0 [Build 7722]