@Generated(value="software.amazon.awssdk:codegen") public final class LambdaAction extends Object implements ToCopyableBuilder<LambdaAction.Builder,LambdaAction>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
LambdaAction.Builder |
Modifier and Type | Method and Description |
---|---|
static LambdaAction.Builder |
builder() |
boolean |
equals(Object obj) |
String |
functionArn()
The Amazon Resource Name (ARN) of the AWS Lambda function.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
InvocationType |
invocationType()
The invocation type of the AWS Lambda function.
|
String |
invocationTypeAsString()
The invocation type of the AWS Lambda function.
|
static Class<? extends LambdaAction.Builder> |
serializableBuilderClass() |
LambdaAction.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
topicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken.
|
String |
toString() |
copy
public String topicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of
an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about
Amazon SNS topics, see the Amazon SNS
Developer Guide.
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon SNS Developer Guide.public String functionArn()
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.
arn:aws:lambda:us-west-2:account-id:function:MyFunction
. For more information about AWS
Lambda, see the AWS Lambda Developer
Guide.public InvocationType invocationType()
The invocation type of the AWS Lambda function. An invocation type of RequestResponse
means that the
execution of the function will immediately result in a response, and a value of Event
means that the
function will be 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 when you want to make a mail flow decision, such
as whether to stop the receipt rule or the receipt rule set.
If the service returns an enum value that is not available in the current SDK version, invocationType
will return InvocationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from invocationTypeAsString()
.
RequestResponse
means
that the execution of the function will immediately result in a response, and a value of
Event
means that the function will be 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 when you want to make
a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
InvocationType
public String invocationTypeAsString()
The invocation type of the AWS Lambda function. An invocation type of RequestResponse
means that the
execution of the function will immediately result in a response, and a value of Event
means that the
function will be 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 when you want to make a mail flow decision, such
as whether to stop the receipt rule or the receipt rule set.
If the service returns an enum value that is not available in the current SDK version, invocationType
will return InvocationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from invocationTypeAsString()
.
RequestResponse
means
that the execution of the function will immediately result in a response, and a value of
Event
means that the function will be 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 when you want to make
a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
InvocationType
public LambdaAction.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<LambdaAction.Builder,LambdaAction>
public static LambdaAction.Builder builder()
public static Class<? extends LambdaAction.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.