Aws2-lambda

Since Camel 3.2

Only producer is supported

The AWS2 Lambda component supports create, get, list, delete, and invoke AWS Lambda functions.

Prerequisites

You must have a valid Amazon Web Services developer account, and be signed up to use Amazon Lambda. More information is available at AWS Lambda.

When creating a Lambda function, you need to specify an IAM role which has at least the AWSLambdaBasicExecuteRole policy attached.

URI Format

aws2-lambda://functionName[?options]

You can append query options to the URI in the following format:

?options=value&option2=value&...

Required Lambda component options

You have to provide the awsLambdaClient in the Registry or your accessKey and secretKey to access the Amazon Lambda service.

Usage

Static credentials, Default Credential Provider and Profile Credentials Provider

You have the possibility of avoiding the usage of explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.

The order of evaluation for Default Credentials Provider is the following:

Java system properties - aws.accessKeyId and aws.secretKey.
Environment variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
Web Identity Token from AWS STS.
The shared credentials and config files.
Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set.
Amazon EC2 Instance profile credentials.

You have also the possibility of using Profile Credentials Provider, by specifying the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.

Only one of static, default and profile credentials could be used at the same time.

For more information about this you can look at AWS credentials documentation

List of Available Operations

listFunctions
getFunction
createFunction
deleteFunction
invokeFunction
updateFunction
createEventSourceMapping
deleteEventSourceMapping
listEventSourceMapping
listTags
tagResource
untagResource
publishVersion
listVersions
createAlias
deleteAlias
getAlias
listAliases

Examples

Producer Example

To have a full understanding of how the component works, you may have a look at these integration tests

Producer Examples

CreateFunction: this operation will create a function for you in AWS Lambda

  from("direct:createFunction").to("aws2-lambda://GetHelloWithName?operation=createFunction").to("mock:result");

and by sending

        template.send("direct:createFunction", ExchangePattern.InOut, new Processor() {
            @Override
            public void process(Exchange exchange) throws Exception {
                exchange.getIn().setHeader(Lambda2Constants.RUNTIME, "nodejs6.10");
                exchange.getIn().setHeader(Lambda2Constants.HANDLER, "GetHelloWithName.handler");
                exchange.getIn().setHeader(Lambda2Constants.DESCRIPTION, "Hello with node.js on Lambda");
                exchange.getIn().setHeader(Lambda2Constants.ROLE,
                        "arn:aws:iam::643534317684:role/lambda-execution-role");

                ClassLoader classLoader = getClass().getClassLoader();
                File file = new File(
                        classLoader
                                .getResource("org/apache/camel/component/aws2/lambda/function/node/GetHelloWithName.zip")
                                .getFile());
                FileInputStream inputStream = new FileInputStream(file);
                exchange.getIn().setBody(inputStream);
            }
        });

Using a POJO as body

Sometimes building an AWS Request can be complex because of multiple options. We introduce the possibility to use a POJO as the body. In AWS Lambda there are multiple operations you can submit, as an example for Get Function request, you can do something like:

from("direct:getFunction")
     .setBody(GetFunctionRequest.builder().functionName("test").build())
     .to("aws2-lambda://GetHelloWithName?awsLambdaClient=#awsLambdaClient&operation=getFunction&pojoRequest=true")

In this way, you’ll pass the request directly without the need of passing headers and options specifically related to this operation.

Dependencies

Maven users will need to add the following dependency to their pom.xml.

pom.xml

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws2-lambda</artifactId>
    <version>${camel-version}</version>
</dependency>

where ${camel-version} must be replaced by the actual version of Camel.

Component Configurations

Name	Description	Default	Type
configuration	Component configuration		object
lazyStartProducer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
operation	The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction	invokeFunction	object
overrideEndpoint	Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option	false	boolean
pojoRequest	If we want to use a POJO request as body or not	false	boolean
region	The region in which the Lambda client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()		string
uriEndpointOverride	Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option		string
autowiredEnabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	boolean
awsLambdaClient	To use an existing configured AwsLambdaClient client		object
healthCheckConsumerEnabled	Used for enabling or disabling all consumer based health checks from this component	true	boolean
healthCheckProducerEnabled	Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.	true	boolean
proxyHost	To define a proxy host when instantiating the Lambda client		string
proxyPort	To define a proxy port when instantiating the Lambda client		integer
proxyProtocol	To define a proxy protocol when instantiating the Lambda client	HTTPS	object
accessKey	Amazon AWS Access Key		string
profileCredentialsName	If using a profile credentials provider, this parameter will set the profile name		string
secretKey	Amazon AWS Secret Key		string
sessionToken	Amazon AWS Session Token used when the user needs to assume an IAM role		string
trustAllCertificates	If we want to trust all certificates in case of overriding the endpoint	false	boolean
useDefaultCredentialsProvider	Set whether the Lambda client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.	false	boolean
useProfileCredentialsProvider	Set whether the Lambda client should expect to load credentials through a profile credentials provider.	false	boolean
useSessionCredentials	Set whether the Lambda client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Lambda.	false	boolean

Endpoint Configurations

Name	Description	Default	Type
function	Name of the Lambda function.		string
operation	The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction	invokeFunction	object
overrideEndpoint	Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option	false	boolean
pojoRequest	If we want to use a POJO request as body or not	false	boolean
region	The region in which the Lambda client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()		string
uriEndpointOverride	Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option		string
lazyStartProducer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
awsLambdaClient	To use an existing configured AwsLambdaClient client		object
proxyHost	To define a proxy host when instantiating the Lambda client		string
proxyPort	To define a proxy port when instantiating the Lambda client		integer
proxyProtocol	To define a proxy protocol when instantiating the Lambda client	HTTPS	object
accessKey	Amazon AWS Access Key		string
profileCredentialsName	If using a profile credentials provider, this parameter will set the profile name		string
secretKey	Amazon AWS Secret Key		string
sessionToken	Amazon AWS Session Token used when the user needs to assume an IAM role		string
trustAllCertificates	If we want to trust all certificates in case of overriding the endpoint	false	boolean
useDefaultCredentialsProvider	Set whether the Lambda client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.	false	boolean
useProfileCredentialsProvider	Set whether the Lambda client should expect to load credentials through a profile credentials provider.	false	boolean
useSessionCredentials	Set whether the Lambda client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Lambda.	false	boolean