Interface CfnReceiptRule.ILambdaActionProperty
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).
Namespace: Amazon.CDK.AWS.SES
Assembly: Amazon.CDK.AWS.SES.dll
Syntax (csharp)
public interface ILambdaActionProperty
Syntax (vb)
Public Interface ILambdaActionProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SES;
var lambdaActionProperty = new LambdaActionProperty {
FunctionArn = "functionArn",
// the properties below are optional
InvocationType = "invocationType",
TopicArn = "topicArn"
};
Synopsis
Properties
FunctionArn | The Amazon Resource Name (ARN) of the AWS Lambda function. |
InvocationType | The invocation type of the AWS Lambda function. |
TopicArn | The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. |
Properties
FunctionArn
The Amazon Resource Name (ARN) of the AWS Lambda function.
string FunctionArn { get; }
Property Value
System.String
Remarks
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
The invocation type of the AWS Lambda function.
virtual string InvocationType { get; }
Property Value
System.String
Remarks
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
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed.
virtual string TopicArn { get; }
Property Value
System.String
Remarks
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 .