Kamelet Catalog

aws lambda sink AWS Lambda Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Calls an AWS Lambda function for each message, with the body as the event of the function, and waits for its result.

Use it to run your own serverless code on each message, such as enriching an order, checking a document or calling another API, without running a server for it.

Input: the body is the event given to the function, as JSON text, such as {"orderId":"A-1"}. Turn structured data such as a Map into JSON text first, for example with json-serialize-action.

Output: when it is used inside a route, the body afterwards is what the function returned, as text (JSON text for most functions). The CamelAwsLambdaStatusCode header holds the status code of the call.

Good to know: an error raised inside the function does not fail the message: the body is then the error that the function reported, and the CamelAwsLambdaFunctionError header is set, for example to Unhandled. A function that does not exist fails the message. Each call waits until the function ends; the function cannot be called asynchronously (invocation type Event). Set operation to read the settings, versions or aliases of the function instead of calling it, or to publish a new version; the body afterwards is then the answer of AWS, an object of the AWS SDK for Java, such as a GetFunctionConfigurationResponse (not JSON text). To reach AWS through an HTTP proxy, set proxyHost and proxyPort, and set proxyProtocol to HTTP for a proxy that takes plain HTTP, such as Squid. Headers that start with CamelAwsLambda are removed from the message first, so they cannot change what the Kamelet does.

Configuration Options

The following table summarizes the configuration options available for the aws-lambda-sink Kamelet:

Property Name Description Type Default Example

function

Function Name

Required The name of the Lambda function to call, as shown in the Lambda console. The ARN of the function also works.

string

my-function

region

AWS Region

Required The AWS region of the function, such as eu-west-1.

Enum values:

* ap-south-1 * eu-south-1 * us-gov-east-1 * me-central-1 * ca-central-1 * eu-central-1 * us-iso-west-1 * us-west-1 * us-west-2 * af-south-1 * eu-north-1 * eu-west-3 * eu-west-2 * eu-west-1 * ap-northeast-3 * ap-northeast-2 * ap-northeast-1 * me-south-1 * sa-east-1 * ap-east-1 * cn-north-1 * us-gov-west-1 * ap-southeast-1 * ap-southeast-2 * us-iso-east-1 * ap-southeast-3 * us-east-1 * us-east-2 * cn-northwest-1 * us-isob-east-1 * aws-global * aws-cn-global * aws-us-gov-global * aws-iso-global * aws-iso-b-global

string

eu-west-1

accessKey

Access Key

The access key ID of an IAM user, which AWS gives when you create an access key for the user (in the AWS console: IAM, Users, Security credentials). Use it together with secretKey, or leave both empty and set useDefaultCredentialsProvider or useProfileCredentialsProvider instead.

string

operation

Operation

What to do with each message: invokeFunction calls the function; getFunction and getFunctionConfiguration read the settings of the function, such as its runtime, memory and timeout (getFunction adds the location of its code and its tags); listVersions and listAliases list its published versions and aliases; publishVersion publishes the current code and settings as a new version; listFunctions lists all the functions of the region. Only invokeFunction uses the body. When it is not set, the function is called.

Enum values:

* invokeFunction * getFunction * getFunctionConfiguration * listVersions * listAliases * publishVersion * listFunctions

string

getFunctionConfiguration

profileCredentialsName

Profile Credentials Name

The name of the profile to use from the AWS credentials file. Only used when useProfileCredentialsProvider is true.

string

proxyHost

Proxy Host

The host name or IP address of an HTTP proxy to send the calls to AWS through, such as the proxy of a company network. Used only together with proxyPort. When it is not set, the calls go straight to AWS.

string

proxy.example.com

proxyPort

Proxy Port

The port of the proxy in proxyHost, such as 3128 for Squid. Used only together with proxyHost.

integer

3128

proxyProtocol

Proxy Protocol

How to talk to the proxy itself: HTTP or HTTPS. It is not the protocol of the calls to AWS, which stay encrypted, as the proxy only passes them on. When it is not set, it is HTTPS, which needs a proxy that takes TLS connections. Most company proxies, such as Squid, take plain HTTP: set HTTP for them. With the wrong one, every call fails, for example with Unsupported or unrecognized SSL message.

Enum values:

* HTTP * HTTPS

string

HTTP

secretKey

Secret Key

The secret access key that goes with accessKey. AWS shows it only once, when the access key is created.

string

sessionToken

Session Token

The session token of temporary credentials, which AWS gives together with their access key and secret key. Only used when useSessionCredentials is true.

string

useDefaultCredentialsProvider

Default Credentials Provider

If true, the credentials are found the way the AWS SDK finds them: from the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables, the shared credentials file, or the IAM role of the machine, container or pod it runs on. Then accessKey and secretKey are not needed.

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

If true, the credentials are read from a profile of the AWS credentials file (~/.aws/credentials), the one named in profileCredentialsName.

boolean

false

useSessionCredentials

Session Credentials

If true, it logs in with temporary credentials, such as those of an assumed IAM role: accessKey, secretKey and sessionToken together.

boolean

false

Dependencies

At runtime, the aws-lambda-sink Kamelet relies upon the presence of the following dependencies:

  • camel:aws2-lambda

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:aws-lambda-sink"

You can now run it directly through the following command

camel run route.yaml

AWS Lambda Sink Kamelet Description

Authentication methods

In this Kamelet you can avoid using 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 can also use the Profile Credentials Provider, by setting the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.

Only one of access key/secret key or default credentials provider could be used

For more information, see the AWS credentials documentation

Reading the Settings of a Function or Publishing a Version

By default, the Kamelet calls the function for each message and waits for its result. Set operation to do something else with the function named in function:

  • getFunction and getFunctionConfiguration: read the settings of the function, such as its runtime, memory and timeout; getFunction adds the location of its code and its tags.

  • listVersions and listAliases: list the published versions and the aliases of the function.

  • publishVersion: publish the current code and settings of the function as a new version.

  • listFunctions: list all the functions of the region.

These operations do not use the body. The body afterwards is the answer of AWS, an object of the AWS SDK for Java, such as a GetFunctionConfigurationResponse, not JSON text.

The function cannot be called asynchronously (invocation type Event): each call waits until the function ends.

The step that sends to the Kamelet, in a route, to publish a new version of the function:

- to:
    uri: "kamelet:aws-lambda-sink"
    parameters:
      function: "my-function"
      region: "eu-west-1"
      useDefaultCredentialsProvider: true
      operation: "publishVersion"

Through an HTTP Proxy

Where AWS can be reached only through an HTTP proxy, as in many company networks, set proxyHost and proxyPort to the proxy. proxyProtocol is how the Kamelet talks to the proxy itself, not to AWS: it is HTTPS when it is not set, so set it to HTTP for a proxy that takes plain HTTP, such as Squid. The calls to AWS stay encrypted, as the proxy only passes them on. The Kamelet has no option for a proxy user or password.

The step that sends to the Kamelet, in a route:

- to:
    uri: "kamelet:aws-lambda-sink"
    parameters:
      function: "my-function"
      region: "eu-west-1"
      useDefaultCredentialsProvider: true
      proxyHost: "proxy.example.com"
      proxyPort: 3128
      proxyProtocol: "HTTP"