Chapter 5. AWS 2 Lambda

5.1. URI Format

aws2-lambda://functionName[?options]

You can append query options to the URI in the following format, options=value&option2=value&…

5.2. Configuring Options

Camel components are configured on two separate levels:

component level
endpoint level

5.2.1. Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

5.2.2. Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

5.3. Component Options

The AWS Lambda component supports 16 options, which are listed below.

Name	Description	Default	Type
configuration (producer)	Component configuration.		Lambda2Configuration
lazyStartProducer (producer)	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 (producer)	The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction. Enum values: listFunctions getFunction createAlias deleteAlias getAlias listAliases createFunction deleteFunction invokeFunction updateFunction createEventSourceMapping deleteEventSourceMapping listEventSourceMapping listTags tagResource untagResource publishVersion listVersions	invokeFunction	Lambda2Operations
overrideEndpoint (producer)	Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option.	false	boolean
pojoRequest (producer)	If we want to use a POJO request as body or not.	false	boolean
region (producer)	The region in which 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
trustAllCertificates (producer)	If we want to trust all certificates in case of overriding the endpoint.	false	boolean
uriEndpointOverride (producer)	Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option.		String
useDefaultCredentialsProvider (producer)	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
autowiredEnabled (advanced)	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 (advanced)	Autowired To use a existing configured AwsLambdaClient as client.		LambdaClient
proxyHost (proxy)	To define a proxy host when instantiating the Lambda client.		String
proxyPort (proxy)	To define a proxy port when instantiating the Lambda client.		Integer
proxyProtocol (proxy)	To define a proxy protocol when instantiating the Lambda client. Enum values: HTTP HTTPS	HTTPS	Protocol
accessKey (security)	Amazon AWS Access Key.		String
secretKey (security)	Amazon AWS Secret Key.		String

5.4. Endpoint Options

The AWS Lambda endpoint is configured using URI syntax:

aws2-lambda:function

with the following path and query parameters:

5.4.1. Path Parameters (1 parameters)

Name	Description	Default	Type
function (producer)	Required Name of the Lambda function.		String

5.4.2. Query Parameters (14 parameters)

Name	Description	Default	Type
lazyStartProducer (producer)	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 (producer)	The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction. Enum values: listFunctions getFunction createAlias deleteAlias getAlias listAliases createFunction deleteFunction invokeFunction updateFunction createEventSourceMapping deleteEventSourceMapping listEventSourceMapping listTags tagResource untagResource publishVersion listVersions	invokeFunction	Lambda2Operations
overrideEndpoint (producer)	Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option.	false	boolean
pojoRequest (producer)	If we want to use a POJO request as body or not.	false	boolean
region (producer)	The region in which 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
trustAllCertificates (producer)	If we want to trust all certificates in case of overriding the endpoint.	false	boolean
uriEndpointOverride (producer)	Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option.		String
useDefaultCredentialsProvider (producer)	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
awsLambdaClient (advanced)	Autowired To use a existing configured AwsLambdaClient as client.		LambdaClient
proxyHost (proxy)	To define a proxy host when instantiating the Lambda client.		String
proxyPort (proxy)	To define a proxy port when instantiating the Lambda client.		Integer
proxyProtocol (proxy)	To define a proxy protocol when instantiating the Lambda client. Enum values: HTTP HTTPS	HTTPS	Protocol
accessKey (security)	Amazon AWS Access Key.		String
secretKey (security)	Amazon AWS Secret Key.		String

Required Lambda component options

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

5.5. Usage

5.5.1. Static credentials vs Default Credential Provider

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

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.

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

5.5.2. Message headers evaluated by the Lambda producer

Operation	Header	Type	Description	Required
All	`CamelAwsLambdaOperation`	`String`	The operation we want to perform. Override operation passed as query parameter	Yes
createFunction	`CamelAwsLambdaS3Bucket`	`String`	Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.	No
createFunction	`CamelAwsLambdaS3Key`	`String`	The Amazon S3 object (the deployment package) key name you want to upload.	No
createFunction	`CamelAwsLambdaS3ObjectVersion`	String	The Amazon S3 object (the deployment package) version you want to upload.	No
createFunction	`CamelAwsLambdaZipFile`	`String`	The local path of the zip file (the deployment package). Content of zip file can also be put in Message body.	No
createFunction	`CamelAwsLambdaRole`	`String`	The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.	Yes
createFunction	`CamelAwsLambdaRuntime`	String	The runtime environment for the Lambda function you are uploading. (nodejs, nodejs4.3, nodejs6.10, java8, python2.7, python3.6, dotnetcore1.0, odejs4.3-edge)	Yes
createFunction	`CamelAwsLambdaHandler`	`String`	The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name.	Yes
createFunction	`CamelAwsLambdaDescription`	`String`	The user-provided description.	No
createFunction	`CamelAwsLambdaTargetArn`	`String`	The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.	No
createFunction	`CamelAwsLambdaMemorySize`	`Integer`	The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.	No
createFunction	`CamelAwsLambdaKMSKeyArn`	`String`	The Amazon Resource Name (ARN) of the KMS key used to encrypt your function’s environment variables. If not provided, AWS Lambda will use a default service key.	No
createFunction	`CamelAwsLambdaPublish`	`Boolean`	This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.	No
createFunction	`CamelAwsLambdaTimeout`	`Integer`	The function execution time at which Lambda should terminate the function. The default is 3 seconds.	No
createFunction	`CamelAwsLambdaTracingConfig`	`String`	Your function’s tracing settings (Active or PassThrough).	No
createFunction	`CamelAwsLambdaEnvironmentVariables`	`Map<String, String>`	The key-value pairs that represent your environment’s configuration settings.	No
createFunction	`CamelAwsLambdaEnvironmentTags`	`Map<String, String>`	The list of tags (key-value pairs) assigned to the new function.	No
createFunction	`CamelAwsLambdaSecurityGroupIds`	`List<String>`	If your Lambda function accesses resources in a VPC, a list of one or more security groups IDs in your VPC.	No
createFunction	`CamelAwsLambdaSubnetIds`	`List<String>`	If your Lambda function accesses resources in a VPC, a list of one or more subnet IDs in your VPC.	No
createAlias	`CamelAwsLambdaFunctionVersion`	`String`	The function version to set in the alias	Yes
createAlias	`CamelAwsLambdaAliasFunctionName`	`String`	The function name to set in the alias	Yes
createAlias	`CamelAwsLambdaAliasFunctionDescription`	`String`	The function description to set in the alias	No
deleteAlias	`CamelAwsLambdaAliasFunctionName`	`String`	The function name of the alias	Yes
getAlias	`CamelAwsLambdaAliasFunctionName`	`String`	The function name of the alias	Yes
listAliases	`CamelAwsLambdaFunctionVersion`	`String`	The function version to set in the alias	No

5.6. List of Avalaible Operations

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

5.7. Examples

5.7.1. Producer Example

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

5.7.2. 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);
    }
});

5.8. Using a POJO as body

Sometimes build an AWS Request can be complex, because of multiple options. We introduce the possibility to use a POJO as 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.

5.9. 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 3.18.3 must be replaced by the actual version of Camel.

5.10. Spring Boot Auto-Configuration

When using aws2-lambda with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-aws2-lambda-starter</artifactId>
</dependency>

The component supports 17 options, which are listed below.

Name	Description	Default	Type
camel.component.aws2-lambda.access-key	Amazon AWS Access Key.		String
camel.component.aws2-lambda.autowired-enabled	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
camel.component.aws2-lambda.aws-lambda-client	To use a existing configured AwsLambdaClient as client. The option is a software.amazon.awssdk.services.lambda.LambdaClient type.		LambdaClient
camel.component.aws2-lambda.configuration	Component configuration. The option is a org.apache.camel.component.aws2.lambda.Lambda2Configuration type.		Lambda2Configuration
camel.component.aws2-lambda.enabled	Whether to enable auto configuration of the aws2-lambda component. This is enabled by default.		Boolean
camel.component.aws2-lambda.lazy-start-producer	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
camel.component.aws2-lambda.operation	The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction.		Lambda2Operations
camel.component.aws2-lambda.override-endpoint	Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option.	false	Boolean
camel.component.aws2-lambda.pojo-request	If we want to use a POJO request as body or not.	false	Boolean
camel.component.aws2-lambda.proxy-host	To define a proxy host when instantiating the Lambda client.		String
camel.component.aws2-lambda.proxy-port	To define a proxy port when instantiating the Lambda client.		Integer
camel.component.aws2-lambda.proxy-protocol	To define a proxy protocol when instantiating the Lambda client.		Protocol
camel.component.aws2-lambda.region	The region in which 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
camel.component.aws2-lambda.secret-key	Amazon AWS Secret Key.		String
camel.component.aws2-lambda.trust-all-certificates	If we want to trust all certificates in case of overriding the endpoint.	false	Boolean
camel.component.aws2-lambda.uri-endpoint-override	Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option.		String
camel.component.aws2-lambda.use-default-credentials-provider	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