Class: Aws::S3::Types::QueueConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::QueueConfiguration

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  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, s3:ObjectRestore:Delete, s3:LifecycleTransition, s3:IntelligentTiering, s3:ObjectAcl:Put, s3:LifecycleExpiration:*, s3:LifecycleExpiration:Delete, s3:LifecycleExpiration:DeleteMarkerCreated, s3:ObjectTagging:*, s3:ObjectTagging:Put, s3:ObjectTagging:Delete
  filter: {
    key: {
      filter_rules: [
        {
          name: "prefix", # accepts prefix, suffix
          value: "FilterRuleValue",
        },
      ],
    },
  },
}

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #events ⇒ Array<String>

  A collection of bucket events for which to send notifications.

• #filter ⇒ Types::NotificationConfigurationFilter

  Specifies object key name filtering rules.

• #id ⇒ String

  An optional unique identifier for configurations in a notification configuration.

• #queue_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

Instance Attribute Details

#events ⇒ Array<String>

A collection of bucket events for which to send notifications

Returns:

• (Array<String>)

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

class QueueConfiguration < Struct.new(
  :id,
  :queue_arn,
  :events,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::NotificationConfigurationFilter

Specifies object key name filtering rules. For information about key name filtering, see [Configuring Event Notifications] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html

Returns:

• (Types::NotificationConfigurationFilter)

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

class QueueConfiguration < Struct.new(
  :id,
  :queue_arn,
  :events,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

An optional unique identifier for configurations in a notification configuration. If you don’t provide one, Amazon S3 will assign an ID.

Returns:

• (String)

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

class QueueConfiguration < Struct.new(
  :id,
  :queue_arn,
  :events,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#queue_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

Returns:

• (String)

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

class QueueConfiguration < Struct.new(
  :id,
  :queue_arn,
  :events,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end