Skip to content
v2.278.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',
      }],
    },
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3 as s3

queue_configuration_property = s3.CfnBucket.QueueConfigurationProperty(
    event="event",
    queue="queue",

    # the properties below are optional
    filter=s3.CfnBucket.NotificationFilterProperty(
        s3_key=s3.CfnBucket.S3KeyFilterProperty(
            rules=[s3.CfnBucket.FilterRuleProperty(
                name="name",
                value="value"
            )]
        )
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.s3.*;

QueueConfigurationProperty queueConfigurationProperty = QueueConfigurationProperty.builder()
        .event("event")
        .queue("queue")

        // the properties below are optional
        .filter(NotificationFilterProperty.builder()
                .s3Key(S3KeyFilterProperty.builder()
                        .rules(List.of(FilterRuleProperty.builder()
                                .name("name")
                                .value("value")
                                .build()))
                        .build())
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3;

var queueConfigurationProperty = new QueueConfigurationProperty {
    Event = "event",
    Queue = "queue",

    // the properties below are optional
    Filter = new NotificationFilterProperty {
        S3Key = new S3KeyFilterProperty {
            Rules = new [] { new FilterRuleProperty {
                Name = "name",
                Value = "value"
            } }
        }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

queueConfigurationProperty := &QueueConfigurationProperty{
	Event: jsii.String("event"),
	Queue: jsii.String("queue"),

	// the properties below are optional
	Filter: &NotificationFilterProperty{
		S3Key: &S3KeyFilterProperty{
			Rules: []interface{}{
				&FilterRuleProperty{
					Name: jsii.String("name"),
					Value: jsii.String("value"),
				},
			},
		},
	},
}

Properties ​

eventstringeventstreventStringEventstringEvent*string required #
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 .

filteroptionalIResolvable | CfnBucket.NotificationFilterPropertyfilteroptionaltyping.Union[IResolvable, NotificationFilterProperty]filteroptionalIResolvableFilteroptionalIResolvableFilteroptionalinterface{} #
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*string required #
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.