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 |
|---|---|---|---|---|---|
AWS Region | Required The AWS region of the events to read, as a region code such as 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 | ||
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 | string | |||
Event Source | Read only the events of this AWS service, given as its address, such as | string | secretsmanager.amazonaws.com | ||
Look Back Interval | How often it looks up the | integer | 60000 | ||
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 | ||
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 | ||
Endpoint Overwrite | If true, it connects to the address in | boolean | false | ||
Profile Credentials Name | The name of the profile in the AWS credentials file. Only used when | string | production | ||
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 | string | proxy.example.com | ||
Proxy Port | The port of the proxy in | integer | 3128 | ||
Proxy Protocol | How to talk to the proxy itself: Enum values: * HTTP * HTTPS | string | HTTP | ||
Secret Key | The secret access key that belongs to | string | |||
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 | string | |||
Overwrite Endpoint URI | The address to connect to instead of AWS, as a URL such as | string | http://localhost:4566 | ||
Default Credentials Provider | If true, the credentials are found in the environment instead of in | boolean | false | ||
Profile Credentials Provider | If true, the credentials are read from a named profile in the AWS credentials file ( | boolean | false | ||
Session Credentials | If true, it logs in with temporary credentials: | 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.accessKeyIdandaws.secretKey. -
Environment variables -
AWS_ACCESS_KEY_IDandAWS_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_URIis 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"