AWS Eventbridge
Manage AWS EventBridge cluster instances and consume events via SQS-backed polling.
What’s inside
-
AWS Eventbridge component, URI syntax:
aws2-eventbridge://eventbusNameOrArn
Please refer to the above links for usage and configuration details.
Maven coordinates
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-aws2-eventbridge-starter</artifactId>
</dependency>Spring Boot Auto-Configuration
The starter supports 32 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.aws2-eventbridge.access-key | Amazon AWS Access Key | String | |
camel.component.aws2-eventbridge.auto-create-queue | Whether to auto-create an SQS queue and wire it as an EventBridge rule target. | true | Boolean |
camel.component.aws2-eventbridge.autowired-enabled | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean |
camel.component.aws2-eventbridge.bridge-error-handler | 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. | false | Boolean |
camel.component.aws2-eventbridge.configuration | Component configuration. The option is a org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration type. | EventbridgeConfiguration | |
camel.component.aws2-eventbridge.delete-queue-on-shutdown | Whether to delete the auto-created SQS queue and remove the EventBridge target on shutdown. | true | Boolean |
camel.component.aws2-eventbridge.enabled | Whether to enable auto configuration of the aws2-eventbridge component. This is enabled by default. | Boolean | |
camel.component.aws2-eventbridge.event-pattern-file | EventPattern File | String | |
camel.component.aws2-eventbridge.eventbridge-client | To use an existing configured AWS Eventbridge client. The option is a software.amazon.awssdk.services.eventbridge.EventBridgeClient type. | EventBridgeClient | |
camel.component.aws2-eventbridge.health-check-consumer-enabled | Used for enabling or disabling all consumer based health checks from this component | true | Boolean |
camel.component.aws2-eventbridge.health-check-producer-enabled | Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. | true | Boolean |
camel.component.aws2-eventbridge.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.aws2-eventbridge.max-messages-per-poll | The maximum number of messages to receive per poll from SQS. | 10 | Integer |
camel.component.aws2-eventbridge.operation | The operation to perform | putrule | EventbridgeOperations |
camel.component.aws2-eventbridge.override-endpoint | Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option | false | Boolean |
camel.component.aws2-eventbridge.pojo-request | If we want to use a POJO request as body or not | false | Boolean |
camel.component.aws2-eventbridge.profile-credentials-name | If using a profile credentials provider this parameter will set the profile name | String | |
camel.component.aws2-eventbridge.proxy-host | To define a proxy host when instantiating the Eventbridge client | String | |
camel.component.aws2-eventbridge.proxy-port | To define a proxy port when instantiating the Eventbridge client | Integer | |
camel.component.aws2-eventbridge.proxy-protocol | To define a proxy protocol when instantiating the Eventbridge client | https | Protocol |
camel.component.aws2-eventbridge.queue-url | The URL of an existing SQS queue to use as EventBridge target. If not specified, a queue is auto-created when autoCreateQueue is true. | String | |
camel.component.aws2-eventbridge.region | 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() | String | |
camel.component.aws2-eventbridge.rule-name | The EventBridge rule name to consume events from. Required for consumer. | String | |
camel.component.aws2-eventbridge.secret-key | Amazon AWS Secret Key | String | |
camel.component.aws2-eventbridge.session-token | Amazon AWS Session Token used when the user needs to assume an IAM role | String | |
camel.component.aws2-eventbridge.trust-all-certificates | If we want to trust all certificates in case of overriding the endpoint | false | Boolean |
camel.component.aws2-eventbridge.uri-endpoint-override | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | String | |
camel.component.aws2-eventbridge.use-default-credentials-provider | Set whether the Eventbridge client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | Boolean |
camel.component.aws2-eventbridge.use-profile-credentials-provider | Set whether the Eventbridge client should expect to load credentials through a profile credentials provider. | false | Boolean |
camel.component.aws2-eventbridge.use-session-credentials | 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. | false | Boolean |
camel.component.aws2-eventbridge.visibility-timeout | The duration (in seconds) that received SQS messages are hidden from subsequent receive requests. | 30 | Integer |
camel.component.aws2-eventbridge.wait-time-seconds | The duration (in seconds) for which the SQS receive call waits for messages (long polling). | 20 | Integer |