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

Class: Aws::S3::Types::NotificationConfiguration

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

Overview

Note:

When making an API call, you may pass NotificationConfiguration data as a hash:

{
  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",
            },
          ],
        },
      },
    },
  ],
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#lambda_function_configurationsArray<Types::LambdaFunctionConfiguration>



5404
5405
5406
5407
5408
5409
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5404

class NotificationConfiguration < Struct.new(
  :topic_configurations,
  :queue_configurations,
  :lambda_function_configurations)
  include Aws::Structure
end

#queue_configurationsArray<Types::QueueConfiguration>

Returns:



5404
5405
5406
5407
5408
5409
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5404

class NotificationConfiguration < Struct.new(
  :topic_configurations,
  :queue_configurations,
  :lambda_function_configurations)
  include Aws::Structure
end

#topic_configurationsArray<Types::TopicConfiguration>

Returns:



5404
5405
5406
5407
5408
5409
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5404

class NotificationConfiguration < Struct.new(
  :topic_configurations,
  :queue_configurations,
  :lambda_function_configurations)
  include Aws::Structure
end