You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::BucketNotification

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes 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 'gems/aws-sdk-s3/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

#bucketBucket

Returns:



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

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

#bucket_nameString

Returns:

  • (String)


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

def bucket_name
  @bucket_name
end

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::NotificationConfiguration



71
72
73
74
# File 'gems/aws-sdk-s3/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 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb', line 79

def data_loaded?
  !!@data
end

#lambda_function_configurationsArray<Types::LambdaFunctionConfiguration>



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

def lambda_function_configurations
  data.lambda_function_configurations
end

#loadself 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 'gems/aws-sdk-s3/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 'gems/aws-sdk-s3/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_configurationsArray<Types::QueueConfiguration>

Returns:



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

def queue_configurations
  data.queue_configurations
end

#topic_configurationsArray<Types::TopicConfiguration>

Returns:



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

def topic_configurations
  data.topic_configurations
end