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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing NotificationConfiguration as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

Instance Attribute Summary collapse

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:

#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>) —

    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.

Returns:

  • (Array<Types::TopicConfiguration>) —

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