Class LambdaAction
- All Implemented Interfaces:
Serializable
,Cloneable
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.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The Amazon Resource Name (ARN) of the AWS Lambda function.The invocation type of the AWS Lambda function.The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken.int
hashCode()
void
setFunctionArn
(String functionArn) The Amazon Resource Name (ARN) of the AWS Lambda function.void
setInvocationType
(InvocationType invocationType) The invocation type of the AWS Lambda function.void
setInvocationType
(String invocationType) The invocation type of the AWS Lambda function.void
setTopicArn
(String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken.toString()
Returns a string representation of this object; useful for testing and debugging.withFunctionArn
(String functionArn) The Amazon Resource Name (ARN) of the AWS Lambda function.withInvocationType
(InvocationType invocationType) The invocation type of the AWS Lambda function.withInvocationType
(String invocationType) The invocation type of the AWS Lambda function.withTopicArn
(String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken.
-
Constructor Details
-
LambdaAction
public LambdaAction()
-
-
Method Details
-
setTopicArn
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.- Parameters:
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 isarn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
-
getTopicArn
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.- Returns:
- 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.
-
withTopicArn
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.- Parameters:
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 isarn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFunctionArn
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.- Parameters:
functionArn
- The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN isarn:aws:lambda:us-west-2:account-id:function:MyFunction
. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
-
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.- Returns:
- 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.
-
withFunctionArn
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.- Parameters:
functionArn
- The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN isarn:aws:lambda:us-west-2:account-id:function:MyFunction
. For more information about AWS Lambda, see the AWS Lambda Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInvocationType
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 ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.- Parameters:
invocationType
- The invocation type of the AWS Lambda function. An invocation type ofRequestResponse
means that the execution of the function will immediately result in a response, and a value ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.- See Also:
-
getInvocationType
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 ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.- Returns:
- 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 ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set. - See Also:
-
withInvocationType
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 ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.- Parameters:
invocationType
- The invocation type of the AWS Lambda function. An invocation type ofRequestResponse
means that the execution of the function will immediately result in a response, and a value ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setInvocationType
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 ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.- Parameters:
invocationType
- The invocation type of the AWS Lambda function. An invocation type ofRequestResponse
means that the execution of the function will immediately result in a response, and a value ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.- See Also:
-
withInvocationType
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 ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.- Parameters:
invocationType
- The invocation type of the AWS Lambda function. An invocation type ofRequestResponse
means that the execution of the function will immediately result in a response, and a value ofEvent
means that the function will be invoked asynchronously. The default value isEvent
. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.There is a 30-second timeout on RequestResponse
invocations. You should useEvent
invocation in most cases. UseRequestResponse
only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-