AWS Eventbridge

Manage AWS EventBridge cluster instances and consume events via SQS-backed polling.

Metadata

Property	Value
Scheme	`aws2-eventbridge`
Support Level	Stable
Labels	cloud,management
Version	4.20.0 (CEQ 3.36.0)

Maven Dependency

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-eventbridge</artifactId>
    <version>4.20.0 (CEQ 3.36.0)</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`eventbusNameOrArn`	string	✓		Event bus name or ARN
`eventPatternFile`	string			EventPattern File
`operation`	enum	✓	`putRule`	The operation to perform
`overrideEndpoint`	boolean		`false`	Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option
`pojoRequest`	boolean		`false`	If we want to use a POJO request as body or not
`region`	enum			The region in which the Eventbridge 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()
`uriEndpointOverride`	string			Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option
`autoCreateQueue`	boolean		`true`	Whether to auto-create an SQS queue and wire it as an EventBridge rule target.
`deleteQueueOnShutdown`	boolean		`true`	Whether to delete the auto-created SQS queue and remove the EventBridge target on shutdown.
`maxMessagesPerPoll`	integer		`10`	The maximum number of messages to receive per poll from SQS.
`queueUrl`	string			The URL of an existing SQS queue to use as EventBridge target. If not specified, a queue is auto-created when autoCreateQueue is true.
`ruleName`	string			The EventBridge rule name to consume events from. Required for consumer.
`sendEmptyMessageWhenIdle`	boolean		`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`visibilityTimeout`	integer		`30`	The duration (in seconds) that received SQS messages are hidden from subsequent receive requests.
`waitTimeSeconds`	integer		`20`	The duration (in seconds) for which the SQS receive call waits for messages (long polling).
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	enum			Sets the exchange pattern when the consumer creates an exchange.
`pollStrategy`	object			A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`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.
`eventbridgeClient`	object			To use an existing configured AWS Eventbridge client
`proxyHost`	string			To define a proxy host when instantiating the Eventbridge client
`proxyPort`	integer			To define a proxy port when instantiating the Eventbridge client
`proxyProtocol`	enum		`HTTPS`	To define a proxy protocol when instantiating the Eventbridge client
`backoffErrorThreshold`	integer			The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer			The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer			To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
`delay`	integer		`500`	Milliseconds before the next poll.
`greedy`	boolean		`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer		`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer		`0`	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.
`runLoggingLevel`	enum		`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object			Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
`scheduler`	object		`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object			To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	enum		`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean		`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
`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 an IAM role
`trustAllCertificates`	boolean		`false`	If we want to trust all certificates in case of overriding the endpoint
`useDefaultCredentialsProvider`	boolean		`false`	Set whether the Eventbridge client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
`useProfileCredentialsProvider`	boolean		`false`	Set whether the Eventbridge client should expect to load credentials through a profile credentials provider.
`useSessionCredentials`	boolean		`false`	Set whether the Eventbridge client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Eventbridge.