| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for aws-mq |
| |
| == Spring Boot Auto-Configuration |
| |
| When using aws-mq with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.springboot</groupId> |
| <artifactId>camel-aws-mq-starter</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel core version --> |
| </dependency> |
| ---- |
| |
| |
| The component supports 13 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *camel.component.aws-mq.access-key* | Amazon AWS Access Key | | String |
| | *camel.component.aws-mq.amazon-mq-client* | To use a existing configured AmazonMQClient as client. The option is a com.amazonaws.services.mq.AmazonMQ type. | | AmazonMQ |
| | *camel.component.aws-mq.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-mq.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.aws-mq.configuration* | The Component configuration. The option is a org.apache.camel.component.aws.mq.MQConfiguration type. | | MQConfiguration |
| | *camel.component.aws-mq.enabled* | Whether to enable auto configuration of the aws-mq component. This is enabled by default. | | Boolean |
| | *camel.component.aws-mq.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-mq.operation* | The operation to perform. It can be listBrokers,createBroker,deleteBroker | | MQOperations |
| | *camel.component.aws-mq.proxy-host* | To define a proxy host when instantiating the MQ client | | String |
| | *camel.component.aws-mq.proxy-port* | To define a proxy port when instantiating the MQ client | | Integer |
| | *camel.component.aws-mq.proxy-protocol* | To define a proxy protocol when instantiating the MQ client | | Protocol |
| | *camel.component.aws-mq.region* | The region in which MQ 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-mq.secret-key* | Amazon AWS Secret Key | | String |
| |=== |
| // spring-boot-auto-configure options: END |
