Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

10.6. AWS-Kinesis

Kinesis Component
Copy link

Available as of Camel 2.17
The Kinesis component supports receiving messages from and sending messages to Amazon Kinesis service.
Note
You must have a valid Amazon Web Services developer account, and be signed up to use Amazon Kinesis. More information are available at AWS Kinesis

URI Format
Copy link

aws-kinesis://stream-name[?options]
Copy to Clipboard Toggle word wrap
The stream needs to be created prior to it being used. You can append query options to the URI in the following format, ?options=value&option2=value&...

URI Options
Copy link

Expand
Name
Default Value
Context
Description
amazonKinesisClient
null
Consumer
Reference to a com.amazonaws.services.kinesis.AmazonKinesisClient in the Registry.
maxMessagesPerPoll
100
Consumer
Maximum results that will be returned in each poll to the AWS API, Given that the shard iterator is unique to the consumer, changing it shouldn't effect other consumers.
iteratorType
TRIM_HORIZON
Consumer
One of trim_horizon or latest. See http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html for descriptions of these two iterator types.
Note
You have to provide the amazonKinesisClient in the Registry with proxies and relevant credentials configured.

Batch Consumer
Copy link

This component implements the Batch Consumer.
This allows you for instance to know how many messages exists in this batch and for instance let the Aggregator aggregate this number of messages.

Message headers set by the Kinesis consumer
Copy link

Expand
Header
Type
Description
CamelAwsKinesisSequenceNumber
String
The sequence number of the record. This is represented as a String as it size is not defined by the API. If it is to be used as a numerical type then use
CamelAwsKinesisApproximateArrivalTimestamp
String
The time AWS assigned as the arrival time of the record.
CamelAwsKinesisPartitionKey
String
Identifies which shard in the stream the data record is assigned to.

AmazonKinesis configuration
Copy link

You will need to create an instance of AmazonDynamoDBStreamsClient and bind it to the registry 
ClientConfiguration clientConfiguration = new ClientConfiguration();
clientConfiguration.setProxyHost("http://myProxyHost");
clientConfiguration.setProxyPort(8080);

Region region = Region.getRegion(Regions.fromName(region));
region.createClient(AmazonDynamoDBStreamsClient.class, null, clientConfiguration);
// the 'null' here is the AWSCredentialsProvider which defaults to an instance of DefaultAWSCredentialsProviderChain

registry.bind("kinesisClient", client);
Copy to Clipboard Toggle word wrap

Providing AWS Credentials
Copy link

It is recommended that the credentials are obtained by using the DefaultAWSCredentialsProviderChain that is the default when creating a new ClientConfiguration instance, however, a different AWSCredentialsProvider can be specified when calling createClient(...).

Dependencies
Copy link

Maven users will need to add the following dependency to their pom.xml. 
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws</artifactId>
    <version>${camel-version}</version>
</dependency>
Copy to Clipboard Toggle word wrap
where ${camel-version} must be replaced by the actual version of Camel (2.17 or higher).
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat