aws-cdk-lib.aws_s3.CfnBucket.QueueConfigurationProperty

interface QueueConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.S3.CfnBucket.QueueConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnBucket_QueueConfigurationProperty
Javasoftware.amazon.awscdk.services.s3.CfnBucket.QueueConfigurationProperty
Pythonaws_cdk.aws_s3.CfnBucket.QueueConfigurationProperty
TypeScript aws-cdk-lib » aws_s3 » CfnBucket » QueueConfigurationProperty

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

Example

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

NameTypeDescription
eventstringThe Amazon S3 bucket event about which you want to publish messages to Amazon SQS.
queuestringThe Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.
filter?IResolvable | NotificationFilterPropertyThe filtering rules that determine which objects trigger notifications.

event

Type: string

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 .


queue

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

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


filter?

Type: IResolvable | NotificationFilterProperty (optional)

The filtering rules that determine which objects trigger notifications.

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 .