interface LambdaActionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.SES.CfnReceiptRule.LambdaActionProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsses#CfnReceiptRule_LambdaActionProperty`
Java	`software.amazon.awscdk.services.ses.CfnReceiptRule.LambdaActionProperty`
Python	`aws_cdk.aws_ses.CfnReceiptRule.LambdaActionProperty`
TypeScript	`aws-cdk-lib` » `aws_ses` » `CfnReceiptRule` » `LambdaActionProperty`

When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide .

For information about using AWS Lambda actions in 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 lambdaActionProperty: ses.CfnReceiptRule.LambdaActionProperty = {
  functionArn: 'functionArn',

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

Properties

Name	Type	Description
functionArn	`string`	The Amazon Resource Name (ARN) of the AWS Lambda function.
invocationType?	`string`	The invocation type of the AWS Lambda function.
topicArn?	`string`	The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed.

functionArn

Type: string

The Amazon Resource Name (ARN) of the AWS Lambda function.

An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction . For more information about AWS Lambda, see the AWS Lambda Developer Guide .

invocationType?

Type: string (optional)

The invocation type of the AWS Lambda function.

An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event . For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide .

There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

topicArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed.

You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .