aws-cdk-lib.aws_ses.ReceiptRuleActionConfig

interface ReceiptRuleActionConfig

LanguageType name
.NETAmazon.CDK.AWS.SES.ReceiptRuleActionConfig
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#ReceiptRuleActionConfig
Javasoftware.amazon.awscdk.services.ses.ReceiptRuleActionConfig
Pythonaws_cdk.aws_ses.ReceiptRuleActionConfig
TypeScript (source)aws-cdk-lib » aws_ses » ReceiptRuleActionConfig

Obtainable from AddHeader.bind(), Bounce.bind(), Lambda.bind(), S3.bind(), Sns.bind(), Stop.bind()

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 { 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

NameTypeDescription
addHeaderAction?AddHeaderActionConfigAdds a header to the received email.
bounceAction?BounceActionConfigRejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.
lambdaAction?LambdaActionConfigCalls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
s3Action?S3ActionConfigSaves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.
snsAction?SNSActionConfigPublishes the email content within a notification to Amazon SNS.
stopAction?StopActionConfigTerminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
workmailAction?WorkmailActionConfigCalls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

addHeaderAction?

Type: AddHeaderActionConfig (optional)

Adds a header to the received email.


bounceAction?

Type: BounceActionConfig (optional)

Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.


lambdaAction?

Type: LambdaActionConfig (optional)

Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.


s3Action?

Type: S3ActionConfig (optional)

Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.


snsAction?

Type: SNSActionConfig (optional)

Publishes the email content within a notification to Amazon SNS.


stopAction?

Type: StopActionConfig (optional)

Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.


workmailAction?

Type: WorkmailActionConfig (optional)

Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.