Kamelet Catalog

aws cloudtrail source AWS Cloudtrail Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Reads the events that AWS CloudTrail records in an AWS account, such as API calls and console sign-ins, one message per event.

Use it to react to activity in an AWS account, for example to raise an alert when a secret is read, a security group is changed or someone signs in to the console. Set eventSource to read the events of one AWS service only.

Output: the body is the CloudTrail record of the event, as JSON text. The headers give the ID, the name (such as GetSecretValue), the source (such as secretsmanager.amazonaws.com) and the user name of the event.

Good to know: it looks up the management events that CloudTrail keeps for the region, and reads the events that happen after it starts. It remembers where it is only while it runs: the events that happen while it is stopped are not read. Nothing is removed from CloudTrail. An event can be looked up only some minutes after it happened, and sometimes after a newer event: every lookBackInterval it looks up the last lookBackWindow again, and reads the events it missed. 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.

Configuration Options

The following table summarizes the configuration options available for the aws-cloudtrail-source Kamelet:

Property Name Description Type Default Example

region

AWS Region

Required The AWS region of the events to read, as a region code such as eu-west-1 or us-east-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 you create in the AWS console under IAM, Users, Security credentials. Use it together with secretKey. Leave both out when useDefaultCredentialsProvider or useProfileCredentialsProvider is true.

string

eventSource

Event Source

Read only the events of this AWS service, given as its address, such as s3.amazonaws.com or secretsmanager.amazonaws.com. When it is not set, the events of all services are read.

string

secretsmanager.amazonaws.com

lookBackInterval

Look Back Interval

How often it looks up the lookBackWindow again, in milliseconds. A late event is read at most this long after it became visible. When it is not set, it is 60000, one minute. It must be above 0 unless lookBackWindow is 0, or the integration does not start. Needs Camel 4.24 or later.

integer

60000

lookBackWindow

Look Back Window

How far back it looks up the events again, in milliseconds, to read the events that CloudTrail made visible after a newer one. When it is not set, it is 600000, ten minutes. 0 turns the second lookup off, and then such a late event is not read. Needs Camel 4.24 or later.

integer

600000

maxResults

Max Results

How many events to fetch in one request to CloudTrail, from 1 to 50. Depending on the Camel version, a poll reads one such page of the newest events, or all new events page by page.

integer

1

overrideEndpoint

Endpoint Overwrite

If true, it connects to the address in uriEndpointOverride instead of to AWS. Use it for a local stand-in of AWS such as LocalStack.

boolean

false

profileCredentialsName

Profile Credentials Name

The name of the profile in the AWS credentials file. Only used when useProfileCredentialsProvider is true; when it is not set, the default profile is used.

string

production

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 belongs to accessKey. The AWS console shows it only once, when the access key is created.

string

sessionToken

Session Token

The session token of temporary credentials, which comes with their access key and secret key, for example from AWS STS when you assume an IAM role. Only used when useSessionCredentials is true.

string

uriEndpointOverride

Overwrite Endpoint URI

The address to connect to instead of AWS, as a URL such as http://localhost:4566 for LocalStack. Only used when overrideEndpoint is true.

string

http://localhost:4566

useDefaultCredentialsProvider

Default Credentials Provider

If true, the credentials are found in the environment instead of in accessKey and secretKey: the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables, the ~/.aws/credentials file, or the IAM role of the EC2 instance, ECS task or Kubernetes pod the integration runs on.

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

If true, the credentials are read from a named profile in the AWS credentials file (~/.aws/credentials), as the AWS CLI does. Name the profile in profileCredentialsName.

boolean

false

useSessionCredentials

Session Credentials

If true, it logs in with temporary credentials: accessKey, secretKey and sessionToken, such as the ones AWS STS gives when you assume an IAM role.

boolean

false

Dependencies

At runtime, the aws-cloudtrail-source Kamelet relies upon the presence of the following dependencies:

  • camel:aws-cloudtrail

  • 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:aws-cloudtrail-source"
      parameters:
        .
        .
        .
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

AWS Cloudtrail Source 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

Events That Become Visible Late

The Kamelet reads the events that happen after it starts. CloudTrail can make an event visible some minutes after it happened, and after a newer event, which the Kamelet has then already read past. So every lookBackInterval (one minute when it is not set) the Kamelet looks up the last lookBackWindow (ten minutes when it is not set) again, and reads the events it has not read yet. Set lookBackWindow to 0 to turn this off, or set a shorter lookBackInterval to read a late event sooner, at the cost of more lookups. Both options need Camel 4.24 or later.

- route:
    from:
      uri: "kamelet:aws-cloudtrail-source"
      parameters:
        region: "eu-west-1"
        useDefaultCredentialsProvider: true
        lookBackWindow: 900000
        lookBackInterval: 30000
      steps:
        - to:
            uri: "kamelet:log-sink"

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.

- route:
    from:
      uri: "kamelet:aws-cloudtrail-source"
      parameters:
        region: "eu-west-1"
        useDefaultCredentialsProvider: true
        proxyHost: "proxy.example.com"
        proxyPort: 3128
        proxyProtocol: "HTTP"
      steps:
        - to:
            uri: "kamelet:log-sink"