Interface ReceiptRuleActionConfig

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.434Z") @Stability(Stable) public interface ReceiptRuleActionConfig extends software.amazon.jsii.JsiiSerializable
Properties for a receipt rule action.

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.ses.*;
 ReceiptRuleActionConfig receiptRuleActionConfig = ReceiptRuleActionConfig.builder()
         .addHeaderAction(AddHeaderActionConfig.builder()
                 .headerName("headerName")
                 .headerValue("headerValue")
                 .build())
         .bounceAction(BounceActionConfig.builder()
                 .message("message")
                 .sender("sender")
                 .smtpReplyCode("smtpReplyCode")
                 // the properties below are optional
                 .statusCode("statusCode")
                 .topicArn("topicArn")
                 .build())
         .lambdaAction(LambdaActionConfig.builder()
                 .functionArn("functionArn")
                 // the properties below are optional
                 .invocationType("invocationType")
                 .topicArn("topicArn")
                 .build())
         .s3Action(S3ActionConfig.builder()
                 .bucketName("bucketName")
                 // the properties below are optional
                 .kmsKeyArn("kmsKeyArn")
                 .objectKeyPrefix("objectKeyPrefix")
                 .topicArn("topicArn")
                 .build())
         .snsAction(SNSActionConfig.builder()
                 .encoding("encoding")
                 .topicArn("topicArn")
                 .build())
         .stopAction(StopActionConfig.builder()
                 .scope("scope")
                 // the properties below are optional
                 .topicArn("topicArn")
                 .build())
         .workmailAction(WorkmailActionConfig.builder()
                 .organizationArn("organizationArn")
                 // the properties below are optional
                 .topicArn("topicArn")
                 .build())
         .build();
 
  • Method Details

    • getAddHeaderAction

      @Stability(Stable) @Nullable default AddHeaderActionConfig getAddHeaderAction()
      Adds a header to the received email.
    • getBounceAction

      @Stability(Stable) @Nullable default BounceActionConfig getBounceAction()
      Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.
    • getLambdaAction

      @Stability(Stable) @Nullable default LambdaActionConfig getLambdaAction()
      Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
    • getS3Action

      @Stability(Stable) @Nullable default S3ActionConfig getS3Action()
      Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.
    • getSnsAction

      @Stability(Stable) @Nullable default SNSActionConfig getSnsAction()
      Publishes the email content within a notification to Amazon SNS.
    • getStopAction

      @Stability(Stable) @Nullable default StopActionConfig getStopAction()
      Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
    • getWorkmailAction

      @Stability(Stable) @Nullable default WorkmailActionConfig getWorkmailAction()
      Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
    • builder

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