You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::BucketPolicy

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name, options = {}) ⇒ BucketPolicy #initialize(options = {}) ⇒ BucketPolicy

Returns a new instance of BucketPolicy

Overloads:

  • #initialize(bucket_name, options = {}) ⇒ BucketPolicy

    Parameters:

    • bucket_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ BucketPolicy

    Options Hash (options):

    • :bucket_name (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @bucket_name = extract_bucket_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#bucketBucket

Returns:



206
207
208
209
210
211
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 206

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

#bucket_nameString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 29

def bucket_name
  @bucket_name
end

#clientClient

Returns:



42
43
44
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 42

def client
  @client
end

#dataTypes::GetBucketPolicyOutput

Returns the data for this Aws::S3::BucketPolicy. Calls Client#get_bucket_policy if #data_loaded? is false.

Returns:



62
63
64
65
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 62

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



70
71
72
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 70

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_policy.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


176
177
178
179
180
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 176

def delete(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.delete_bucket_policy(options)
  resp.data
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::S3::BucketPolicy. Returns self making it possible to chain methods.

bucket_policy.reload.data

Returns:

  • (self)


52
53
54
55
56
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 52

def load
  resp = @client.get_bucket_policy(bucket: @bucket_name)
  @data = resp.data
  self
end

#policyIO

The bucket policy as a JSON document.

Returns:

  • (IO)


35
36
37
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 35

def policy
  data[:policy]
end

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_policy.put({
  content_md5: "ContentMD5",
  confirm_remove_self_bucket_access: false,
  policy: "Policy", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :content_md5 (String)
  • :confirm_remove_self_bucket_access (Boolean)

    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

  • :policy (required, String)

    The bucket policy as a JSON document.

Returns:

  • (EmptyStructure)


197
198
199
200
201
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 197

def put(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.put_bucket_policy(options)
  resp.data
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::S3::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb', line 152

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end