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

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 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#eventsArray<String>

A collection of bucket events for which to send notifications

Returns:

  • (Array<String>)


14276
14277
14278
14279
14280
14281
14282
14283
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14276

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

#filterTypes::NotificationConfigurationFilter

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



14276
14277
14278
14279
14280
14281
14282
14283
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14276

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

#idString

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

Returns:

  • (String)


14276
14277
14278
14279
14280
14281
14282
14283
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14276

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

#queue_arnString

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)


14276
14277
14278
14279
14280
14281
14282
14283
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14276

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