Class AWS::S3::Bucket
In: lib/aws/s3/bucket.rb
Parent: Base

Buckets are containers for objects (the files you store on S3). To create a new bucket you just specify its name.

  # Pick a unique name, or else you'll get an error
  # if the name is already taken.
  Bucket.create('jukebox')

Bucket names must be unique across the entire S3 system, sort of like domain names across the internet. If you try to create a bucket with a name that is already taken, you will get an error.

Assuming the name you chose isn’t already taken, your new bucket will now appear in the bucket list:

  Service.buckets
  # => [#<AWS::S3::Bucket @attributes={"name"=>"jukebox"}>]

Once you have succesfully created a bucket you can you can fetch it by name using Bucket.find.

  music_bucket = Bucket.find('jukebox')

The bucket that is returned will contain a listing of all the objects in the bucket.

  music_bucket.objects.size
  # => 0

If all you are interested in is the objects of the bucket, you can get to them directly using Bucket.objects.

  Bucket.objects('jukebox').size
  # => 0

By default all objects will be returned, though there are several options you can use to limit what is returned, such as specifying that only objects whose name is after a certain place in the alphabet be returned, and etc. Details about these options can be found in the documentation for Bucket.find.

To add an object to a bucket you specify the name of the object, its value, and the bucket to put it in.

  file = 'black-flowers.mp3'
  S3Object.store(file, open(file), 'jukebox')

You‘ll see your file has been added to it:

  music_bucket.objects
  # => [#<AWS::S3::S3Object '/jukebox/black-flowers.mp3'>]

You can treat your bucket like a hash and access objects by name:

  jukebox['black-flowers.mp3']
  # => #<AWS::S3::S3Object '/jukebox/black-flowers.mp3'>

In the event that you want to delete a bucket, you can use Bucket.delete.

  Bucket.delete('jukebox')

Keep in mind, like unix directories, you can not delete a bucket unless it is empty. Trying to delete a bucket that contains objects will raise a BucketNotEmpty exception.

Passing the :force => true option to delete will take care of deleting all the bucket’s objects for you.

  Bucket.delete('photos', :force => true)
  # => true

Methods

[]   clear   create   delete   delete   delete_all   each   empty?   find   list   new_object   objects   objects   size  

Included Modules

Enumerable

Public Class methods

Creates a bucket named name.

  Bucket.create('jukebox')

Your bucket name must be unique across all of S3. If the name you request has already been taken, you will get a 409 Conflict response, and a BucketAlreadyExists exception will be raised.

By default new buckets have their access level set to private. You can override this using the :access option.

  Bucket.create('internet_drop_box', :access => :public_read_write)

The full list of access levels that you can set on Bucket and S3Object creation are listed in the README in the section called ‘Setting access levels’.

[Source]

    # File lib/aws/s3/bucket.rb, line 77
77:         def create(name, options = {})
78:           validate_name!(name)
79:           put("/#{name}", options).success?
80:         end

Deletes the bucket named name.

All objects in the bucket must be deleted before the bucket can be deleted. If the bucket is not empty, BucketNotEmpty will be raised.

You can side step this issue by passing the :force => true option to delete which will take care of emptying the bucket before deleting it.

  Bucket.delete('photos', :force => true)

Only the owner of a bucket can delete a bucket, regardless of the bucket’s access control policy.

[Source]

     # File lib/aws/s3/bucket.rb, line 159
159:         def delete(name = nil, options = {})
160:           name = path(name)
161:           find(name).delete_all if options[:force]
162:           # A bit confusing. Calling super actually makes makes an HTTP DELETE request. The delete method is
163:           # defined in the Base class. It happens to have the same name.
164:           super(name).success?
165:         end

Fetches the bucket named name.

  Bucket.find('jukebox')

If a default bucket is inferable from the current connection’s subdomain, or if set explicitly with Base.set_current_bucket, it will be used if no bucket is specified.

  MusicBucket.current_bucket
  => 'jukebox'
  MusicBucket.find.name
  => 'jukebox'

By default all objects contained in the bucket will be returned (sans their data) along with the bucket. You can access your objects using the Bucket#objects method.

  Bucket.find('jukebox').objects

There are several options which allow you to limit which objects are retrieved. The list of object filtering options are listed in the documentation for Bucket.objects.

[Source]

     # File lib/aws/s3/bucket.rb, line 101
101:         def find(name = nil, options = {})
102:           new(get(path(name, options)).bucket)
103:         end

List all your buckets. This is a convenient wrapper around AWS::S3::Service.buckets.

[Source]

     # File lib/aws/s3/bucket.rb, line 168
168:         def list(reload = false)
169:           Service.buckets(reload)
170:         end

Return just the objects in the bucket named name.

By default all objects of the named bucket will be returned. There are options, though, for filtering which objects are returned.

Object filtering options

  • :max_keys - The maximum number of keys you’d like to see in the response body. The server may return fewer than this many keys, but will not return more.
      Bucket.objects('jukebox').size
      # => 3
      Bucket.objects('jukebox', :max_keys => 1).size
      # => 1
    
  • :prefix - Restricts the response to only contain results that begin with the specified prefix.
      Bucket.objects('jukebox')
      # => [<AWS::S3::S3Object '/jazz/miles.mp3'>, <AWS::S3::S3Object '/jazz/dolphy.mp3'>, <AWS::S3::S3Object '/classical/malher.mp3'>]
      Bucket.objects('jukebox', :prefix => 'classical')
      # => [<AWS::S3::S3Object '/classical/malher.mp3'>]
    
  • :marker - Marker specifies where in the result set to resume listing. It restricts the response to only contain results that occur alphabetically after the value of marker. To retrieve the next set of results, use the last key from the current page of results as the marker in your next request.
      # Skip 'mahler'
      Bucket.objects('jukebox', :marker => 'mb')
      # => [<AWS::S3::S3Object '/jazz/miles.mp3'>]
    

Examples

  # Return no more than 2 objects whose key's are listed alphabetically after the letter 'm'.
  Bucket.objects('jukebox', :marker => 'm', :max_keys => 2)
  # => [<AWS::S3::S3Object '/jazz/miles.mp3'>, <AWS::S3::S3Object '/classical/malher.mp3'>]

  # Return no more than 2 objects whose key's are listed alphabetically after the letter 'm' and have the 'jazz' prefix.
  Bucket.objects('jukebox', :marker => 'm', :max_keys => 2, :prefix => 'jazz')
  # => [<AWS::S3::S3Object '/jazz/miles.mp3'>]

[Source]

     # File lib/aws/s3/bucket.rb, line 144
144:         def objects(name = nil, options = {})
145:           find(name, options).object_cache
146:         end

Public Instance methods

Fetches the object named object_key, or nil if the bucket does not contain an object with the specified key.

  bucket.objects
  => [#<AWS::S3::S3Object '/marcel_molina/beluga_baby.jpg'>,
      #<AWS::S3::S3Object '/marcel_molina/tongue_overload.jpg'>]
  bucket['beluga_baby.jpg']
  => #<AWS::S3::S3Object '/marcel_molina/beluga_baby.jpg'>

[Source]

     # File lib/aws/s3/bucket.rb, line 204
204:       def [](object_key)
205:         detect {|file| file.key == object_key.to_s}
206:       end
clear()

Alias for delete_all

Deletes the bucket. See its class method counter part Bucket.delete for caveats about bucket deletion and how to ensure a bucket is deleted no matter what.

[Source]

     # File lib/aws/s3/bucket.rb, line 269
269:       def delete(options = {})
270:         self.class.delete(name, options)
271:       end

Delete all files in the bucket. Use with caution. Can not be undone.

[Source]

     # File lib/aws/s3/bucket.rb, line 274
274:       def delete_all
275:         each do |object|
276:           object.delete
277:         end
278:         self
279:       end

Iterates over the objects in the bucket.

  bucket.each do |object|
    # Do something with the object ...
  end

[Source]

     # File lib/aws/s3/bucket.rb, line 252
252:       def each(&block)
253:         # Dup the collection since we might be destructively modifying the object_cache during the iteration.
254:         objects.dup.each(&block)
255:       end

Returns true if there are no objects in the bucket.

[Source]

     # File lib/aws/s3/bucket.rb, line 258
258:       def empty?
259:         objects.empty?
260:       end

Initializes a new S3Object belonging to the current bucket.

  object = bucket.new_object
  object.value = data
  object.key   = 'classical/mahler.mp3'
  object.store
  bucket.objects.include?(object)
  => true

[Source]

     # File lib/aws/s3/bucket.rb, line 216
216:       def new_object(attributes = {})
217:         object = S3Object.new(attributes)
218:         register(object)
219:         object
220:       end

List S3Object’s of the bucket.

Once fetched the objects will be cached. You can reload the objects by passing :reload.

  bucket.objects(:reload)

You can also filter the objects using the same options listed in Bucket.objects.

  bucket.objects(:prefix => 'jazz')

Using these filtering options will implictly reload the objects.

To reclaim all the objects for the bucket you can pass in :reload again.

[Source]

     # File lib/aws/s3/bucket.rb, line 235
235:       def objects(options = {})
236:         if options.is_a?(Hash)
237:           reload = !options.empty?
238:         else
239:           reload  = options
240:           options = {}
241:         end
242:         
243:         reload!(options) if reload || object_cache.empty?
244:         object_cache
245:       end

Returns the number of objects in the bucket.

[Source]

     # File lib/aws/s3/bucket.rb, line 263
263:       def size
264:         objects.size
265:       end

[Validate]