AWS CDK Reference

Appearance

v2.274.0

ReceiptRuleActionConfig Struct ​

Properties for a receipt rule action.

Source
aws-ses/lib/receipt-rule-action.ts

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
const receiptRuleActionConfig: ses.ReceiptRuleActionConfig = {
  addHeaderAction: {
    headerName: 'headerName',
    headerValue: 'headerValue',
  },
  bounceAction: {
    message: 'message',
    sender: 'sender',
    smtpReplyCode: 'smtpReplyCode',

    // the properties below are optional
    statusCode: 'statusCode',
    topicArn: 'topicArn',
  },
  lambdaAction: {
    functionArn: 'functionArn',

    // the properties below are optional
    invocationType: 'invocationType',
    topicArn: 'topicArn',
  },
  s3Action: {
    bucketName: 'bucketName',

    // the properties below are optional
    kmsKeyArn: 'kmsKeyArn',
    objectKeyPrefix: 'objectKeyPrefix',
    topicArn: 'topicArn',
  },
  snsAction: {
    encoding: 'encoding',
    topicArn: 'topicArn',
  },
  stopAction: {
    scope: 'scope',

    // the properties below are optional
    topicArn: 'topicArn',
  },
  workmailAction: {
    organizationArn: 'organizationArn',

    // the properties below are optional
    topicArn: 'topicArn',
  },
};

Properties ​

addHeaderActionoptionalAddHeaderActionConfigadd_header_actionoptionalAddHeaderActionConfigaddHeaderActionoptionalAddHeaderActionConfigAddHeaderActionoptionalAddHeaderActionConfigAddHeaderActionoptionalAddHeaderActionConfig#
Adds a header to the received email.
bounceActionoptionalBounceActionConfigbounce_actionoptionalBounceActionConfigbounceActionoptionalBounceActionConfigBounceActionoptionalBounceActionConfigBounceActionoptionalBounceActionConfig#
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.
lambdaActionoptionalLambdaActionConfiglambda_actionoptionalLambdaActionConfiglambdaActionoptionalLambdaActionConfigLambdaActionoptionalLambdaActionConfigLambdaActionoptionalLambdaActionConfig#
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
s3ActionoptionalS3ActionConfigs3_actionoptionalS3ActionConfigs3ActionoptionalS3ActionConfigS3ActionoptionalS3ActionConfigS3ActionoptionalS3ActionConfig#
Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.
snsActionoptionalSNSActionConfigsns_actionoptionalSNSActionConfigsnsActionoptionalSNSActionConfigSnsActionoptionalSNSActionConfigSnsActionoptionalSNSActionConfig#
Publishes the email content within a notification to Amazon SNS.
stopActionoptionalStopActionConfigstop_actionoptionalStopActionConfigstopActionoptionalStopActionConfigStopActionoptionalStopActionConfigStopActionoptionalStopActionConfig#
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
workmailActionoptionalWorkmailActionConfigworkmail_actionoptionalWorkmailActionConfigworkmailActionoptionalWorkmailActionConfigWorkmailActionoptionalWorkmailActionConfigWorkmailActionoptionalWorkmailActionConfig#
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.