2 Home
gitea_admin edited this page 2026-03-11 14:35:40 +00:00

AWS Kinesis Firehose

Produce data to AWS Kinesis Firehose streams.

Metadata

Property Value
Scheme aws2-kinesis-firehose
Support Level Stable
Labels cloud,messaging
Version 4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws2-kinesis</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name Type Required Default Description
streamName string Name of the stream
cborEnabled boolean true This option will set the CBOR_ENABLED property during the execution
overrideEndpoint boolean false Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option
uriEndpointOverride string Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option
operation object The operation to do in case the user don't want to send only a record
region string The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()
useDefaultCredentialsProvider boolean false Set whether the Kinesis Firehose client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
lazyStartProducer boolean false 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.
amazonKinesisFirehoseClient object Amazon Kinesis Firehose client to use for all requests for this endpoint
proxyHost string To define a proxy host when instantiating the Kinesis Firehose client
proxyPort integer To define a proxy port when instantiating the Kinesis Firehose client
proxyProtocol object HTTPS To define a proxy protocol when instantiating the Kinesis Firehose client
accessKey string Amazon AWS Access Key
profileCredentialsName string If using a profile credentials provider this parameter will set the profile name.
secretKey string Amazon AWS Secret Key
sessionToken string Amazon AWS Session Token used when the user needs to assume a IAM role
trustAllCertificates boolean false If we want to trust all certificates in case of overriding the endpoint
useProfileCredentialsProvider boolean false Set whether the Kinesis Firehose client should expect to load credentials through a profile credentials provider.
useSessionCredentials boolean false Set whether the Kinesis Firehose client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis Firehose.