class AWS::S3::BucketCollection

Represents a collection of buckets.

You can use this to create a bucket:

s3.buckets.create(:name => "mybucket")

You can get a handle for a specific bucket with indifferent access:

bucket = s3.buckets[:mybucket]
bucket = s3.buckets['mybucket']

You can also use it to find out which buckets are in your account:

s3.buckets.collect(&:name)
#=> ['bucket1', 'bucket2', ...]

Public Instance Methods

[](bucket_name) click to toggle source

Returns the Bucket with the given name.

Makes no requests. The returned bucket object can be used to make requets for the bucket and its objects.

@example

bucket = s3.buckets[:mybucket],
bucket = s3.buckets['mybucket'],

@param [String] bucket_name @return [Bucket]

# File lib/aws/s3/bucket_collection.rb, line 113
def [] bucket_name
  bucket_named(bucket_name)
end

create(bucket_name, options = {}) click to toggle source

Creates and returns a new Bucket. For example:

@note If your bucket name contains one or more periods and it

is hosted in a non-US region, you should make requests
against the bucket using the S3 endpoint specific to the
region in which your bucket resides. For example:

  s3 = AWS::S3.new(:s3_endpoint => "s3-eu-west-1.amazonaws.com")
  bucket = s3.buckets.create("my.eu.bucket")

For a full list of endpoints and regions, see
{http:/%rdocs.amazonwebservices.com/general/latest/gr/index.html?rande.html
Regions and Endpoints} in the Amazon Web Services General
Reference.

@example

bucket = s3.buckets.create('my-bucket')
bucket.name    #=> "my-bucket"
bucket.exists? #=> true

@param [String] bucket_name @param [Hash] options

@option options [String] :location_constraint (nil) The

location where the bucket should be created.  Defaults to
the classic US region; however, if you configure a regional
endpoint for Amazon S3 this option will default to the
appropriate location constraint for the endpoint.  For
example:

  s3 = AWS::S3.new(:s3_endpoint => "s3-us-west-1.amazonaws.com")
  bucket = s3.buckets.create("my-us-west-bucket")
  bucket.location_constraint # => "us-west-1"

@option options [String] :acl (:private) Sets the ACL of the bucket

you are creating.  Valid Values include :private, :public_read, 
:public_read_write, :authenticated_read, :bucket_owner_read and
:bucket_owner_full_control

@return [Bucket]

# File lib/aws/s3/bucket_collection.rb, line 79
def create bucket_name, options = {}

  # auto set the location constraint for the user if it is not 
  # passed in and the endpoint is not the us-standard region.  don't 
  # override the location constraint though, even it is wrong, 
  unless 
    config.s3_endpoint == 's3.amazonaws.com' or
    options[:location_constraint]
  then
    constraint =
      case config.s3_endpoint
      when 's3-eu-west-1.amazonaws.com' then 'EU'
      when %r^s3-(.*)\.amazonaws\.com$/ then $1
      end
    options[:location_constraint] = constraint if constraint
  end

  client.create_bucket(options.merge(:bucket_name => bucket_name))
  bucket_named(bucket_name)

end

each() { |bucket_named(name, owner)| ... } click to toggle source

Iterates the buckets in this collection.

@example

s3.buckets.each do |bucket|
  puts bucket.name
end

@return [nil]

# File lib/aws/s3/bucket_collection.rb, line 126
def each &block
  response = client.list_buckets
  response.buckets.each do |b|
    yield(bucket_named(b.name, response.owner))
  end
  nil
end