class Aws::S3::BucketPolicy
Public Class Methods
@overload def initialize(bucket_name
, options = {})
@param [String] bucket_name @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :bucket_name @option options [Client] :client
# File lib/aws-sdk-s3/bucket_policy.rb, line 22 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) @waiter_block_warned = false end
Public Instance Methods
@return [Bucket]
# File lib/aws-sdk-s3/bucket_policy.rb, line 228 def bucket Bucket.new( name: @bucket_name, client: @client ) end
@return [String]
# File lib/aws-sdk-s3/bucket_policy.rb, line 33 def bucket_name @bucket_name end
@return [Client]
# File lib/aws-sdk-s3/bucket_policy.rb, line 46 def client @client end
@return [Types::GetBucketPolicyOutput]
Returns the data for this {BucketPolicy}. Calls {Client#get_bucket_policy} if {#data_loaded?} is `false`.
# File lib/aws-sdk-s3/bucket_policy.rb, line 66 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-s3/bucket_policy.rb, line 74 def data_loaded? !!@data end
@example Request syntax with placeholder values
bucket_policy.delete({ expected_bucket_owner: "AccountId", })
@param [Hash] options ({}) @option options [String] :expected_bucket_owner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error.
@return [EmptyStructure]
# File lib/aws-sdk-s3/bucket_policy.rb, line 188 def delete(options = {}) options = options.merge(bucket: @bucket_name) resp = @client.delete_bucket_policy(options) resp.data end
@deprecated @api private
# File lib/aws-sdk-s3/bucket_policy.rb, line 237 def identifiers { bucket_name: @bucket_name } end
Loads, or reloads {#data} for the current {BucketPolicy}. Returns `self` making it possible to chain methods.
bucket_policy.reload.data
@return [self]
# File lib/aws-sdk-s3/bucket_policy.rb, line 56 def load resp = @client.get_bucket_policy(bucket: @bucket_name) @data = resp.data self end
The bucket policy as a JSON document. @return [IO]
# File lib/aws-sdk-s3/bucket_policy.rb, line 39 def policy data[:policy] end
@example Request syntax with placeholder values
bucket_policy.put({ content_md5: "ContentMD5", confirm_remove_self_bucket_access: false, policy: "Policy", # required expected_bucket_owner: "AccountId", })
@param [Hash] options ({}) @option options [String] :content_md5
The MD5 hash of the request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
@option options [Boolean] :confirm_remove_self_bucket_access
Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
@option options [required, String] :policy
The bucket policy as a JSON document.
@option options [String] :expected_bucket_owner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error.
@return [EmptyStructure]
# File lib/aws-sdk-s3/bucket_policy.rb, line 219 def put(options = {}) options = options.merge(bucket: @bucket_name) resp = @client.put_bucket_policy(options) resp.data end
@deprecated Use [Aws::S3::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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) do |instance| instance.state.name == 'running' end
## 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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [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.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-s3/bucket_policy.rb, line 158 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
Private Instance Methods
# File lib/aws-sdk-s3/bucket_policy.rb, line 244 def extract_bucket_name(args, options) value = args[0] || options.delete(:bucket_name) case value when String then value when nil then raise ArgumentError, "missing required option :bucket_name" else msg = "expected :bucket_name to be a String, got #{value.class}" raise ArgumentError, msg end end