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) 


19
20
21
22
23
24
 
# File 'lib/aws-sdk-s3/bucket_notification.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

#bucket ⇒ Bucket

Returns:



156
157
158
159
160
161
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 156

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

#bucket_name ⇒ String

Returns:

  • (String) 


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

def bucket_name
  @bucket_name
end

#client ⇒ Client

Returns:



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

Returns:



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

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.



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.

Deprecated. 


165
166
167
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 165

def identifiers
  { bucket_name: @bucket_name }
end

#lambda_function_configurations ⇒ Array<Types::LambdaFunctionConfiguration>

Returns:



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

Returns:

  • (self) 


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

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
        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
        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
        filter: {
          key: {
            filter_rules: [
              {
                name: "prefix", # accepts prefix, suffix
                value: "FilterRuleValue",
              },
            ],
          },
        },
      },
    ],
  },
})

Parameters:

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

    ({})

Options Hash (options):

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

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

Returns:

  • (EmptyStructure) 


147
148
149
150
151
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 147

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

#queue_configurations ⇒ Array<Types::QueueConfiguration>

Returns:



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>

Returns:



34
35
36
 
# File 'lib/aws-sdk-s3/bucket_notification.rb', line 34

def topic_configurations
  data.topic_configurations
end