Interface ReceiptRuleSetProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ReceiptRuleSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:25.946Z") @Stability(Stable) public interface ReceiptRuleSetProps extends software.amazon.jsii.JsiiSerializable
Construction properties for a ReceiptRuleSet.

Example:

 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.ses.actions.*;
 Bucket bucket = new Bucket(this, "Bucket");
 Topic topic = new Topic(this, "Topic");
 ReceiptRuleSet.Builder.create(this, "RuleSet")
         .rules(List.of(ReceiptRuleOptions.builder()
                 .recipients(List.of("hello@aws.com"))
                 .actions(List.of(
                     AddHeader.Builder.create()
                             .name("X-Special-Header")
                             .value("aws")
                             .build(),
                     S3.Builder.create()
                             .bucket(bucket)
                             .objectKeyPrefix("emails/")
                             .topic(topic)
                             .build()))
                 .build(), ReceiptRuleOptions.builder()
                 .recipients(List.of("aws.com"))
                 .actions(List.of(
                     Sns.Builder.create()
                             .topic(topic)
                             .build()))
                 .build()))
         .build();
 
  • Method Details

    • getDropSpam

      @Stability(Stable) @Nullable default Boolean getDropSpam()
      Whether to add a first rule to stop processing messages that have at least one spam indicator.

      Default: false

    • getReceiptRuleSetName

      @Stability(Stable) @Nullable default String getReceiptRuleSetName()
      The name for the receipt rule set.

      Default: - A CloudFormation generated name.

    • getRules

      @Stability(Stable) @Nullable default List<ReceiptRuleOptions> getRules()
      The list of rules to add to this rule set.

      Rules are added in the same order as they appear in the list.

      Default: - No rules are added to the rule set.

    • builder

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