Class: Aws::S3::BucketNotification
- Inherits:
-
Object
- Object
- Aws::S3::BucketNotification
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#bucket_name ⇒ String
-
#event_bridge_configuration ⇒ Types::EventBridgeConfiguration
Enables delivery of events to Amazon EventBridge.
-
#lambda_function_configurations ⇒ Array<Types::LambdaFunctionConfiguration>
Describes the Lambda functions to invoke and the events for which to invoke them.
-
#queue_configurations ⇒ Array<Types::QueueConfiguration>
The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
-
#topic_configurations ⇒ Array<Types::TopicConfiguration>
The topic to which notifications are sent and the events for which notifications are generated.
Actions collapse
Associations collapse
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 = {}) {|resource| ... } ⇒ 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.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#bucket ⇒ Bucket
287 288 289 290 291 292 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 287 def bucket Bucket.new( name: @bucket_name, client: @client ) end |
#bucket_name ⇒ String
33 34 35 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 33 def bucket_name @bucket_name end |
#client ⇒ Client
67 68 69 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 67 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
.
89 90 91 92 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 89 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
97 98 99 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 97 def data_loaded? !!@data end |
#event_bridge_configuration ⇒ Types::EventBridgeConfiguration
Enables delivery of events to Amazon EventBridge.
60 61 62 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 60 def event_bridge_configuration data[:event_bridge_configuration] end |
#lambda_function_configurations ⇒ Array<Types::LambdaFunctionConfiguration>
Describes the Lambda functions to invoke and the events for which to invoke them.
54 55 56 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 54 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
77 78 79 80 81 82 83 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 77 def load resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.get_bucket_notification_configuration(bucket: @bucket_name) end @data = resp.data self end |
#put(options = {}) ⇒ EmptyStructure
276 277 278 279 280 281 282 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 276 def put( = {}) = .merge(bucket: @bucket_name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.put_bucket_notification_configuration() end resp.data end |
#queue_configurations ⇒ Array<Types::QueueConfiguration>
The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
47 48 49 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 47 def queue_configurations data[:queue_configurations] end |
#topic_configurations ⇒ Array<Types::TopicConfiguration>
The topic to which notifications are sent and the events for which notifications are generated.
40 41 42 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 40 def topic_configurations data[:topic_configurations] end |
#wait_until(options = {}) {|resource| ... } ⇒ 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) 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
attempts attempt in seconds invoked before each attempt invoked before each wait
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 181 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::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |