Skip to content
v2.274.0

QueueConfigurationProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';
const queueConfigurationProperty: s3.CfnBucket.QueueConfigurationProperty = {
  event: 'event',
  queue: 'queue',

  // the properties below are optional
  filter: {
    s3Key: {
      rules: [{
        name: 'name',
        value: 'value',
      }],
    },
  },
};

Properties ​

eventstringeventstreventStringEventstringEvent*stringrequired#
The Amazon S3 bucket event about which you want to publish messages to Amazon SQS.

For more information, see Supported Event Types in the Amazon S3 User Guide .

The filtering rules that determine which objects trigger notifications.
notes

For example, you can create a filter so that Amazon S3 sends notifications only when image files with a .jpg extension are added to the bucket. For more information, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide .

queuestringqueuestrqueueStringQueuestringQueue*stringrequired#
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.

FIFO queues are not allowed when enabling an SQS queue as the event notification destination.