software.amazon.awscdk.services.s3

Interface CfnBucket.TopicConfigurationProperty

All Known Implementing Classes:

CfnBucket.TopicConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

public static interface CfnBucket.TopicConfigurationProperty

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic 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.*;
 TopicConfigurationProperty topicConfigurationProperty = TopicConfigurationProperty.builder()
         .event("event")
         .topic("topic")
         // the properties below are optional
         .filter(NotificationFilterProperty.builder()
                 .s3Key(S3KeyFilterProperty.builder()
                         .rules(List.of(FilterRuleProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBucket.TopicConfigurationProperty.Builder	builder()
java.lang.String	getEvent() The Amazon S3 bucket event about which to send notifications.
default java.lang.Object	getFilter() The filtering rules that determine for which objects to send notifications.
java.lang.String	getTopic() The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

Method Detail

getEvent

java.lang.String getEvent()

The Amazon S3 bucket event about which to send notifications.

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

getTopic

java.lang.String getTopic()

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

getFilter

default java.lang.Object getFilter()

The filtering rules that determine for which objects to send 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.

builder

static CfnBucket.TopicConfigurationProperty.Builder builder()

Returns:

a CfnBucket.TopicConfigurationProperty.Builder of CfnBucket.TopicConfigurationProperty