blob: e88dc9e67fce2816ef0a14a19ef5ad08d7583823 [file] [log] [blame]
// kafka-connector options: START
[[camel-aws-swf-kafka-connector-source]]
= camel-aws-swf-kafka-connector source configuration
When using camel-aws-swf-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-aws-swf-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-aws-swf source connector supports 29 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.type* | Activity or workflow One of: [activity] [workflow] | null | HIGH
| *camel.source.endpoint.amazonSWClient* | To use the given AmazonSimpleWorkflowClient as client | null | MEDIUM
| *camel.source.endpoint.dataConverter* | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | null | MEDIUM
| *camel.source.endpoint.domainName* | The workflow domain to use. | null | MEDIUM
| *camel.source.endpoint.eventName* | The workflow or activity event name to use. | null | MEDIUM
| *camel.source.endpoint.region* | Amazon AWS Region. 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() | null | MEDIUM
| *camel.source.endpoint.version* | The workflow or activity event version to use. | null | MEDIUM
| *camel.source.endpoint.bridgeErrorHandler* | 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 | MEDIUM
| *camel.source.endpoint.exceptionHandler* | 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. | null | MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | MEDIUM
| *camel.source.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.source.endpoint.clientConfiguration Parameters* | To configure the ClientConfiguration using the key/values from the Map. | null | MEDIUM
| *camel.source.endpoint.startWorkflowOptions Parameters* | To configure the StartWorkflowOptions using the key/values from the Map. | null | MEDIUM
| *camel.source.endpoint.sWClientParameters* | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | null | MEDIUM
| *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.source.endpoint.activityList* | The list name to consume activities from. | null | MEDIUM
| *camel.source.endpoint.activityThreadPoolSize* | Maximum number of threads in work pool for activity. | 100 | MEDIUM
| *camel.source.endpoint.activityTypeExecutionOptions* | Activity execution options | null | MEDIUM
| *camel.source.endpoint.activityTypeRegistration Options* | Activity registration options | null | MEDIUM
| *camel.source.endpoint.workflowList* | The list name to consume workflows from. | null | MEDIUM
| *camel.source.endpoint.workflowTypeRegistration Options* | Workflow registration options | null | MEDIUM
| *camel.source.endpoint.accessKey* | Amazon AWS Access Key. | null | MEDIUM
| *camel.source.endpoint.secretKey* | Amazon AWS Secret Key. | null | MEDIUM
| *camel.component.aws-swf.accessKey* | Amazon AWS Access Key. | null | MEDIUM
| *camel.component.aws-swf.region* | Amazon AWS Region. | null | MEDIUM
| *camel.component.aws-swf.secretKey* | Amazon AWS Secret Key. | null | MEDIUM
| *camel.component.aws-swf.bridgeErrorHandler* | 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 | MEDIUM
| *camel.component.aws-swf.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.aws-swf.configuration* | The AWS SWF default configuration | null | MEDIUM
|===
// kafka-connector options: END