Class: Aws::S3::BucketNotification
- Inherits:
-
Object
- Object
- Aws::S3::BucketNotification
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-s3/bucket_notification.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #bucket_name ⇒ String
- #lambda_function_configurations ⇒ Array<Types::LambdaFunctionConfiguration>
- #queue_configurations ⇒ Array<Types::QueueConfiguration>
- #topic_configurations ⇒ Array<Types::TopicConfiguration>
Actions collapse
Associations collapse
- #bucket ⇒ Bucket
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::NotificationConfiguration
Returns the data for this BucketNotification.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ BucketNotification
constructor
A new instance of BucketNotification.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current BucketNotification.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, options = {}) ⇒ BucketNotification #initialize(options = {}) ⇒ BucketNotification
Returns a new instance of BucketNotification.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#bucket ⇒ Bucket
251 252 253 254 255 256 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 251 def bucket Bucket.new( name: @bucket_name, client: @client ) end |
#bucket_name ⇒ String
29 30 31 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 29 def bucket_name @bucket_name end |
#client ⇒ Client
51 52 53 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 51 def client @client end |
#data ⇒ Types::NotificationConfiguration
Returns the data for this Aws::S3::BucketNotification. Calls Client#get_bucket_notification_configuration if #data_loaded? is ‘false`.
71 72 73 74 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 71 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
79 80 81 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 79 def data_loaded? !!@data end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
260 261 262 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 260 def identifiers { bucket_name: @bucket_name } end |
#lambda_function_configurations ⇒ Array<Types::LambdaFunctionConfiguration>
44 45 46 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 44 def lambda_function_configurations data[:lambda_function_configurations] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::S3::BucketNotification. Returns ‘self` making it possible to chain methods.
bucket_notification.reload.data
61 62 63 64 65 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 61 def load resp = @client.get_bucket_notification_configuration(bucket: @bucket_name) @data = resp.data self end |
#put(options = {}) ⇒ EmptyStructure
242 243 244 245 246 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 242 def put( = {}) = .merge(bucket: @bucket_name) resp = @client.put_bucket_notification_configuration() resp.data end |
#queue_configurations ⇒ Array<Types::QueueConfiguration>
39 40 41 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 39 def queue_configurations data[:queue_configurations] end |
#topic_configurations ⇒ Array<Types::TopicConfiguration>
34 35 36 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 34 def topic_configurations data[:topic_configurations] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::S3::Client] #wait_until instead
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() {|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
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 161 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |