AWS Kinesis Firehose
Since Camel 2.19
Only producer is supported
The Kinesis Firehose component supports sending messages to Amazon Kinesis Firehose service.
Prerequisites
You must have a valid Amazon Web Services developer account, and be signed up to use Amazon Kinesis Firehose. More information are available at AWS Kinesis Firehose
URI Format
aws-kinesis-firehose://delivery-stream-name[?options]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
The AWS Kinesis Firehose component supports 11 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
amazonKinesisFirehoseClient (producer) |
Amazon Kinesis Firehose client to use for all requests for this endpoint |
AmazonKinesisFirehose |
|
autoDiscoverClient (common) |
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking |
true |
boolean |
configuration (producer) |
The component configuration |
KinesisFirehoseConfiguration |
|
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 |
proxyHost (producer) |
To define a proxy host when instantiating the Kinesis Firehose client |
String |
|
proxyPort (producer) |
To define a proxy port when instantiating the Kinesis Firehose client |
Integer |
|
proxyProtocol (producer) |
To define a proxy protocol when instantiating the Kinesis Firehose client. The value can be one of: HTTP, HTTPS |
HTTPS |
Protocol |
region (producer) |
The region in which Kinesis client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1)You’ll need to use the name Regions.EU_WEST_1.name() |
String |
|
basicPropertyBinding (advanced) |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
accessKey (security) |
Amazon AWS Access Key |
String |
|
secretKey (security) |
Amazon AWS Secret Key |
String |
The AWS Kinesis Firehose endpoint is configured using URI syntax:
aws-kinesis-firehose:streamName
with the following path and query parameters:
Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
streamName |
Required Name of the stream |
String |
Query Parameters (11 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
amazonKinesisFirehoseClient (producer) |
Amazon Kinesis Firehose client to use for all requests for this endpoint |
AmazonKinesisFirehose |
|
autoDiscoverClient (common) |
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking |
true |
boolean |
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 |
proxyHost (producer) |
To define a proxy host when instantiating the Kinesis Firehose client |
String |
|
proxyPort (producer) |
To define a proxy port when instantiating the Kinesis Firehose client |
Integer |
|
proxyProtocol (producer) |
To define a proxy protocol when instantiating the Kinesis Firehose client. The value can be one of: HTTP, HTTPS |
HTTPS |
Protocol |
region (producer) |
The region in which Kinesis client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1)You’ll need to use the name Regions.EU_WEST_1.name() |
String |
|
basicPropertyBinding (advanced) |
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
synchronous (advanced) |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
accessKey (security) |
Amazon AWS Access Key |
String |
|
secretKey (security) |
Amazon AWS Secret Key |
String |
Required Kinesis Firehose component options
You have to provide the amazonKinesisClient in the Registry with proxies and relevant credentials configured.
Usage
Amazon Kinesis Firehose configuration
You will need to create an instance of AmazonKinesisClient 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(AmazonKinesisClient.class, null, clientConfiguration);
// the 'null' here is the AWSCredentialsProvider which defaults to an instance of DefaultAWSCredentialsProviderChain
registry.bind("kinesisFirehoseClient", client);You then have to reference the AmazonKinesisFirehoseClient in the amazonKinesisFirehoseClient URI option.
from("aws-kinesis-firehose://mykinesisdeliverystream?amazonKinesisFirehoseClient=#kinesisClient")
.to("log:out?showAll=true");Providing AWS Credentials
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(…).
Message headers set by the Kinesis producer on successful storage of a Record
| Header | Type | Description |
|---|---|---|
|
|
The record ID, as defined in Response Syntax |
Automatic detection of AmazonKinesisFirehose client in registry
The component is capable of detecting the presence of an AmazonKinesisFirehose bean into the registry. If it’s the only instance of that type it will be used as client and you won’t have to define it as uri parameter. This may be really useful for smarter configuration of the endpoint.
Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-aws-kinesis</artifactId>
<version>${camel-version}</version>
</dependency>where ${camel-version} must be replaced by the actual version of Camel.
Spring Boot Auto-Configuration
When using aws-kinesis 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-aws-kinesis-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 30 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.aws-kinesis-firehose.access-key |
Amazon AWS Access Key |
String |
|
camel.component.aws-kinesis-firehose.amazon-kinesis-firehose-client |
Amazon Kinesis Firehose client to use for all requests for this endpoint. The option is a com.amazonaws.services.kinesisfirehose.AmazonKinesisFirehose type. |
String |
|
camel.component.aws-kinesis-firehose.auto-discover-client |
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking |
true |
Boolean |
camel.component.aws-kinesis-firehose.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.aws-kinesis-firehose.configuration |
The component configuration. The option is a org.apache.camel.component.aws.firehose.KinesisFirehoseConfiguration type. |
String |
|
camel.component.aws-kinesis-firehose.enabled |
Whether to enable auto configuration of the aws-kinesis-firehose component. This is enabled by default. |
Boolean |
|
camel.component.aws-kinesis-firehose.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.aws-kinesis-firehose.proxy-host |
To define a proxy host when instantiating the Kinesis Firehose client |
String |
|
camel.component.aws-kinesis-firehose.proxy-port |
To define a proxy port when instantiating the Kinesis Firehose client |
Integer |
|
camel.component.aws-kinesis-firehose.proxy-protocol |
To define a proxy protocol when instantiating the Kinesis Firehose client |
Protocol |
|
camel.component.aws-kinesis-firehose.region |
The region in which Kinesis client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1)You’ll need to use the name Regions.EU_WEST_1.name() |
String |
|
camel.component.aws-kinesis-firehose.secret-key |
Amazon AWS Secret Key |
String |
|
camel.component.aws-kinesis.access-key |
Amazon AWS Access Key |
String |
|
camel.component.aws-kinesis.amazon-kinesis-client |
Amazon Kinesis client to use for all requests for this endpoint. The option is a com.amazonaws.services.kinesis.AmazonKinesis type. |
String |
|
camel.component.aws-kinesis.auto-discover-client |
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking |
true |
Boolean |
camel.component.aws-kinesis.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.aws-kinesis.bridge-error-handler |
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
Boolean |
camel.component.aws-kinesis.configuration |
The component configuration. The option is a org.apache.camel.component.aws.kinesis.KinesisConfiguration type. |
String |
|
camel.component.aws-kinesis.enabled |
Whether to enable auto configuration of the aws-kinesis component. This is enabled by default. |
Boolean |
|
camel.component.aws-kinesis.iterator-type |
Defines where in the Kinesis stream to start getting records |
ShardIteratorType |
|
camel.component.aws-kinesis.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.aws-kinesis.max-results-per-request |
Maximum number of records that will be fetched in each poll |
1 |
Integer |
camel.component.aws-kinesis.proxy-host |
To define a proxy host when instantiating the Kinesis client |
String |
|
camel.component.aws-kinesis.proxy-port |
To define a proxy port when instantiating the Kinesis client |
Integer |
|
camel.component.aws-kinesis.proxy-protocol |
To define a proxy protocol when instantiating the Kinesis client |
Protocol |
|
camel.component.aws-kinesis.region |
The region in which Kinesis client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1)You’ll need to use the name Regions.EU_WEST_1.name() |
String |
|
camel.component.aws-kinesis.secret-key |
Amazon AWS Secret Key |
String |
|
camel.component.aws-kinesis.sequence-number |
The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER |
String |
|
camel.component.aws-kinesis.shard-closed |
Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a message will be logged and the consumer will restart from the beginning,in case of silent there will be no logging and the consumer will start from the beginning,in case of fail a ReachedClosedStateException will be raised |
KinesisShardClosedStrategyEnum |
|
camel.component.aws-kinesis.shard-id |
Defines which shardId in the Kinesis stream to get records from |
String |