software.amazon.awscdk.services.ses

Interface CfnReceiptRule.LambdaActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReceiptRule.LambdaActionProperty.Jsii$Proxy

Enclosing class:

CfnReceiptRule

@Stability(value=Stable)
public static interface CfnReceiptRule.LambdaActionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ses.*;
 LambdaActionProperty lambdaActionProperty = LambdaActionProperty.builder()
         .functionArn("functionArn")
         // the properties below are optional
         .invocationType("invocationType")
         .topicArn("topicArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnReceiptRule.LambdaActionProperty.Builder A builder for CfnReceiptRule.LambdaActionProperty
static class	CfnReceiptRule.LambdaActionProperty.Jsii$Proxy An implementation for CfnReceiptRule.LambdaActionProperty

Method Summary

Modifier and Type	Method and Description
static CfnReceiptRule.LambdaActionProperty.Builder	builder()
String	getFunctionArn() The Amazon Resource Name (ARN) of the AWS Lambda function.
default String	getInvocationType() The invocation type of the AWS Lambda function.
default String	getTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFunctionArn

@Stability(value=Stable)
 @NotNull
String getFunctionArn()

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 .

getInvocationType

@Stability(value=Stable)
 @Nullable
default String getInvocationType()

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.

getTopicArn

@Stability(value=Stable)
 @Nullable
default String getTopicArn()

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 .

builder

@Stability(value=Stable)
static CfnReceiptRule.LambdaActionProperty.Builder builder()

Returns:

a CfnReceiptRule.LambdaActionProperty.Builder of CfnReceiptRule.LambdaActionProperty