Class: Aws::S3::BucketNotification

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-s3/bucket_notification.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BucketNotification.

Overloads:

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

    Parameters:

    • bucket_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ BucketNotification

    Options Hash (options):

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


20
21
22
23
24
25
26
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 20

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

Instance Method Details

#bucket ⇒ Bucket

Returns:



262
263
264
265
266
267
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 262

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

#bucket_name ⇒ String

Returns:

  • (String) 


31
32
33
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 31

def bucket_name
  @bucket_name
end

#client ⇒ Client

Returns:



59
60
61
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 59

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`.

Returns:



79
80
81
82
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 79

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.



87
88
89
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 87

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.

Deprecated. 


271
272
273
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 271

def identifiers
  { bucket_name: @bucket_name }
end

#lambda_function_configurations ⇒ Array<Types::LambdaFunctionConfiguration>

Describes the AWS Lambda functions to invoke and the events for which to invoke them.

Returns:



52
53
54
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 52

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

Returns:

  • (self) 


69
70
71
72
73
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 69

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

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_notification.put({
  notification_configuration: { # required
    topic_configurations: [
      {
        id: "NotificationId",
        topic_arn: "TopicArn", # required
        events: ["s3:ReducedRedundancyLostObject"], # required, accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
        filter: {
          key: {
            filter_rules: [
              {
                name: "prefix", # accepts prefix, suffix
                value: "FilterRuleValue",
              },
            ],
          },
        },
      },
    ],
    queue_configurations: [
      {
        id: "NotificationId",
        queue_arn: "QueueArn", # required
        events: ["s3:ReducedRedundancyLostObject"], # required, accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
        filter: {
          key: {
            filter_rules: [
              {
                name: "prefix", # accepts prefix, suffix
                value: "FilterRuleValue",
              },
            ],
          },
        },
      },
    ],
    lambda_function_configurations: [
      {
        id: "NotificationId",
        lambda_function_arn: "LambdaFunctionArn", # required
        events: ["s3:ReducedRedundancyLostObject"], # required, accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
        filter: {
          key: {
            filter_rules: [
              {
                name: "prefix", # accepts prefix, suffix
                value: "FilterRuleValue",
              },
            ],
          },
        },
      },
    ],
  },
})

Parameters:

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

    ({})

Options Hash (options):

  • :notification_configuration (required, Types::NotificationConfiguration) —

    A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

Returns:

  • (EmptyStructure) 


253
254
255
256
257
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 253

def put(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.put_bucket_notification_configuration(options)
  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.

Returns:



45
46
47
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 45

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.

Returns:



38
39
40
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 38

def topic_configurations
  data[:topic_configurations]
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 171

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