AWS::SES::ReceiptRule LambdaAction - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::SES::ReceiptRule LambdaAction

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

To enable Amazon SES to call your Amazon 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 Amazon Lambda actions in receipt rules, see the Amazon SES Developer Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "FunctionArn" : String, "InvocationType" : String, "TopicArn" : String }

YAML

FunctionArn: String InvocationType: String TopicArn: String

Properties

FunctionArn

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

Required: Yes

Type: String

Update requires: No interruption

InvocationType

The invocation type of the Amazon 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 Amazon Lambda invocation types, see the Amazon Lambda Developer Guide.

Important

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.

Required: No

Type: String

Allowed values: Event | RequestResponse

Update requires: No interruption

TopicArn

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.

Required: No

Type: String

Update requires: No interruption