Interface CfnBucket.TopicConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnBucket.TopicConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnBucket

@Stability(Stable) public static interface CfnBucket.TopicConfigurationProperty extends software.amazon.jsii.JsiiSerializable
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();
 
  • Method Details

    • getEvent

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) static CfnBucket.TopicConfigurationProperty.Builder builder()
      Returns:
      a CfnBucket.TopicConfigurationProperty.Builder of CfnBucket.TopicConfigurationProperty