AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::NotificationConfiguration

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

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #lambda_function_configurations ⇒ Array<Types::LambdaFunctionConfiguration>

  Describes the AWS 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.

Instance Attribute Details

#lambda_function_configurations ⇒ Array<Types::LambdaFunctionConfiguration>

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

Returns:

• (Array<Types::LambdaFunctionConfiguration>)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9259

class NotificationConfiguration < Struct.new(
  :topic_configurations,
  :queue_configurations,
  :lambda_function_configurations)
  SENSITIVE = []
  include Aws::Structure
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:

• (Array<Types::QueueConfiguration>)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9259

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

#topic_configurations ⇒ Array<Types::TopicConfiguration>

The topic to which notifications are sent and the events for which notifications are generated.

Returns:

• (Array<Types::TopicConfiguration>)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9259

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