Class LambdaAction
- java.lang.Object
-
- com.amazonaws.services.simpleemail.model.LambdaAction
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class LambdaAction extends Object implements 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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LambdaAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LambdaAction
clone()
boolean
equals(Object obj)
String
getFunctionArn()
The Amazon Resource Name (ARN) of the AWS Lambda function.String
getInvocationType()
The invocation type of the AWS Lambda function.String
getTopicArn()
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.LambdaAction
withFunctionArn(String functionArn)
The Amazon Resource Name (ARN) of the AWS Lambda function.LambdaAction
withInvocationType(InvocationType invocationType)
The invocation type of the AWS Lambda function.LambdaAction
withInvocationType(String invocationType)
The invocation type of the AWS Lambda function.LambdaAction
withTopicArn(String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken.
-
-
-
Method Detail
-
setTopicArn
public void setTopicArn(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.- 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
public String 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
public LambdaAction withTopicArn(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.- 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
public void setFunctionArn(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.- 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
public 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.- 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
public LambdaAction withFunctionArn(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.- 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
public void setInvocationType(String 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 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:
InvocationType
-
getInvocationType
public String 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:
InvocationType
-
withInvocationType
public LambdaAction withInvocationType(String 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 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:
InvocationType
-
setInvocationType
public void setInvocationType(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 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:
InvocationType
-
withInvocationType
public LambdaAction withInvocationType(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 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:
InvocationType
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public LambdaAction clone()
-
-