Package software.amazon.awscdk.services.s3

Interface CfnBucket.QueueConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.QueueConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.QueueConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.QueueConfigurationProperty.Builder	A builder for CfnBucket.QueueConfigurationProperty
static final class	CfnBucket.QueueConfigurationProperty.Jsii$Proxy	An implementation for CfnBucket.QueueConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.QueueConfigurationProperty.Builder	builder()
String	getEvent()	The Amazon S3 bucket event about which you want to publish messages to Amazon SQS.
default Object	getFilter()	The filtering rules that determine which objects trigger notifications.
String	getQueue()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEvent

@Stability(Stable)
@NotNull
String getEvent()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html#cfn-s3-bucket-queueconfiguration-event

getQueue

@Stability(Stable)
@NotNull
String getQueue()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html#cfn-s3-bucket-queueconfiguration-queue

getFilter

@Stability(Stable)
@Nullable
default Object getFilter()

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 .

Returns union: either IResolvable or CfnBucket.NotificationFilterProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html#cfn-s3-bucket-queueconfiguration-filter

builder

@Stability(Stable)
static CfnBucket.QueueConfigurationProperty.Builder builder()

Returns:

a CfnBucket.QueueConfigurationProperty.Builder of CfnBucket.QueueConfigurationProperty