Class: Aws::S3::Resource

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-s3/resource.rb

Overview

This class provides a resource oriented interface for S3. To create a resource object:

resource = Aws::S3::Resource.new(region: 'us-west-2')

You can supply a client object with custom configuration that will be used for all resource operations. If you do not pass `:client`, a default client will be constructed.

client = Aws::S3::Client.new(region: 'us-west-2')
resource = Aws::S3::Resource.new(client: client)

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Resource

Returns a new instance of Resource.

Parameters:

  • options ({}) (defaults to: {})

Options Hash (options):


27
28
29
# File 'lib/aws-sdk-s3/resource.rb', line 27

def initialize(options = {})
  @client = options[:client] || Client.new(options)
end

Instance Method Details

#bucket(name) ⇒ Bucket

Parameters:

  • name (String)

Returns:


108
109
110
111
112
113
# File 'lib/aws-sdk-s3/resource.rb', line 108

def bucket(name)
  Bucket.new(
    name: name,
    client: @client
  )
end

#buckets(options = {}) ⇒ Bucket::Collection

Examples:

Request syntax with placeholder values


s3.buckets()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:


120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'lib/aws-sdk-s3/resource.rb', line 120

def buckets(options = {})
  batches = Enumerator.new do |y|
    batch = []
    resp = @client.list_buckets(options)
    resp.data.buckets.each do |b|
      batch << Bucket.new(
        name: b.name,
        data: b,
        client: @client
      )
    end
    y.yield(batch)
  end
  Bucket::Collection.new(batches)
end

#clientClient

Returns:


32
33
34
# File 'lib/aws-sdk-s3/resource.rb', line 32

def client
  @client
end

#create_bucket(options = {}) ⇒ Bucket

Examples:

Request syntax with placeholder values


bucket = s3.create_bucket({
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read
  bucket: "BucketName", # required
  create_bucket_configuration: {
    location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2
  },
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write: "GrantWrite",
  grant_write_acp: "GrantWriteACP",
  object_lock_enabled_for_bucket: false,
  object_ownership: "BucketOwnerPreferred", # accepts BucketOwnerPreferred, ObjectWriter, BucketOwnerEnforced
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :acl (String)

    The canned ACL to apply to the bucket.

  • :bucket (required, String)

    The name of the bucket to create.

  • :create_bucket_configuration (Types::CreateBucketConfiguration)

    The configuration information for the bucket.

  • :grant_full_control (String)

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

  • :grant_read (String)

    Allows grantee to list the objects in the bucket.

  • :grant_read_acp (String)

    Allows grantee to read the bucket ACL.

  • :grant_write (String)

    Allows grantee to create new objects in the bucket.

    For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

  • :grant_write_acp (String)

    Allows grantee to write the ACL for the applicable bucket.

  • :object_lock_enabled_for_bucket (Boolean)

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.

  • :object_ownership (String)

    The container element for object ownership for a bucket's ownership controls.

    BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the `bucket-owner-full-control` canned ACL.

    ObjectWriter - The uploading account will own the object if the object is uploaded with the `bucket-owner-full-control` canned ACL.

    BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or bucket owner full control ACLs, such as the `bucket-owner-full-control` canned ACL or an equivalent form of this ACL expressed in the XML format.

Returns:


96
97
98
99
100
101
102
# File 'lib/aws-sdk-s3/resource.rb', line 96

def create_bucket(options = {})
  @client.create_bucket(options)
  Bucket.new(
    name: options[:bucket],
    client: @client
  )
end