Class: AWS::S3::AccessControlList

Inherits:
Object
  • Object
show all
Includes:
ACLObject
Defined in:
lib/aws/s3/access_control_list.rb

Overview

Represents an access control list for S3 objects and buckets. For example:

acl = AccessControlList.new
acl.grant(:full_control).
  to(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
acl.to_xml                   # => '<AccessControlPolicy>...'

You can also construct an AccessControlList from a hash:

AccessControlList.new(
  :owner => { :id => "8a6925ce4adf588a4f21c32aa379004fef" },
  :grants => [{ :grantee => {
                  :canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef",
                },
                :permission => :full_control }]
)

See Also:

Defined Under Namespace

Classes: Grant, GrantBuilder, Grantee, Owner, Permission

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ACLObject

#body_xml, included, #initialize, #to_s, #to_xml, #valid?, #validate!, #validate_input

Instance Attribute Details

#grantslist of AccessControlList::Grant

The list of grants. You can set this as a list of hashes, for example:

acl.grants = [{ :grantee => { :canonical_user_id =>
                              "8a6925ce4adf588a4f21c32aa379004fef" },
                :permission => :full_control }]

Returns:


46
47
48
# File 'lib/aws/s3/access_control_list.rb', line 46

def grants
  @grants
end

#ownerAccessControlList::Owner

The owner of the access control list. You can set this as a hash, for example:

acl.owner = { :id => '8a6925ce4adf588a4f21c32aa379004fef' }

This attribute is required when setting an ACL.

Returns:


46
47
48
# File 'lib/aws/s3/access_control_list.rb', line 46

def owner
  @owner
end

Instance Method Details

#element_nameObject


206
207
208
# File 'lib/aws/s3/access_control_list.rb', line 206

def element_name
  "AccessControlPolicy"
end

#grant(permission) ⇒ GrantBuilder

Convenience method for constructing a new grant and adding it to the ACL. Example usage:

acl.grants.size               # => 0
acl.grant(:full_control).
  to(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
acl.grants.size               # => 1

Returns:


239
240
241
# File 'lib/aws/s3/access_control_list.rb', line 239

def grant(permission)
  GrantBuilder.new(self, Grant.new(:permission => permission))
end

#stagObject


201
202
203
# File 'lib/aws/s3/access_control_list.rb', line 201

def stag
  super()+" xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\""
end