aws-cdk-lib.aws_ses.CfnReceiptRule.ActionProperty

interface ActionProperty

LanguageType name
.NETAmazon.CDK.AWS.SES.CfnReceiptRule.ActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#CfnReceiptRule_ActionProperty
Javasoftware.amazon.awscdk.services.ses.CfnReceiptRule.ActionProperty
Pythonaws_cdk.aws_ses.CfnReceiptRule.ActionProperty
TypeScript aws-cdk-lib » aws_ses » CfnReceiptRule » ActionProperty

An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own.

An instance of this data type can represent only one action.

For information about setting up receipt rules, see the Amazon SES Developer Guide .

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 actionProperty: ses.CfnReceiptRule.ActionProperty = {
  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?IResolvable | AddHeaderActionPropertyAdds a header to the received email.
bounceAction?IResolvable | BounceActionPropertyRejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
lambdaAction?IResolvable | LambdaActionPropertyCalls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
s3Action?IResolvable | S3ActionPropertySaves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
snsAction?IResolvable | SNSActionPropertyPublishes the email content within a notification to Amazon SNS.
stopAction?IResolvable | StopActionPropertyTerminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
workmailAction?IResolvable | WorkmailActionPropertyCalls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

addHeaderAction?

Type: IResolvable | AddHeaderActionProperty (optional)

Adds a header to the received email.


bounceAction?

Type: IResolvable | BounceActionProperty (optional)

Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).


lambdaAction?

Type: IResolvable | LambdaActionProperty (optional)

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


s3Action?

Type: IResolvable | S3ActionProperty (optional)

Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.


snsAction?

Type: IResolvable | SNSActionProperty (optional)

Publishes the email content within a notification to Amazon SNS.


stopAction?

Type: IResolvable | StopActionProperty (optional)

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


workmailAction?

Type: IResolvable | WorkmailActionProperty (optional)

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