blob: 70650db52cb9194d106ea1cc7a9d226507838900 [file] [log] [blame]
// kafka-connector options: START
[[camel-aws-swf-kafka-connector-sink]]
= camel-aws-swf-kafka-connector sink configuration
When using camel-aws-swf-kafka-connector as sink 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 sink connector supports 30 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.type* | Activity or workflow One of: [activity] [workflow] | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.amazonSW Client* | To use the given AmazonSimpleWorkflowClient as client | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.data Converter* | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.domainName* | The workflow domain to use. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.eventName* | The workflow or activity event name to use. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.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 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.version* | The workflow or activity event version to use. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.lazyStart 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 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.client ConfigurationParameters* | To configure the ClientConfiguration using the key/values from the Map. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.start WorkflowOptionsParameters* | To configure the StartWorkflowOptions using the key/values from the Map. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.sWClient Parameters* | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | null | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.activity SchedulingOptions* | Activity scheduling options | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.child Policy* | The policy to use on child workflows when terminating a workflow. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.execution StartToCloseTimeout* | Set the execution start to close timeout. | "3600" | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.operation* | Workflow operation One of: [SIGNAL] [CANCEL] [TERMINATE] [GET_STATE] [START] [DESCRIBE] [GET_HISTORY] | "START" | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.signalName* | The name of the signal to send to the workflow. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.state ResultType* | The type of the result when a workflow state is queried. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.taskStart ToCloseTimeout* | Set the task start to close timeout. | "600" | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.termination Details* | Details for terminating a workflow. | null | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.termination Reason* | The reason for terminating a workflow. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.accessKey* | Amazon AWS Access Key. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.secretKey* | Amazon AWS Secret Key. | null | ConfigDef.Importance.MEDIUM
| *camel.component.aws-swf.access Key* | Amazon AWS Access Key. | null | ConfigDef.Importance.MEDIUM
| *camel.component.aws-swf.region* | Amazon AWS Region. | null | ConfigDef.Importance.MEDIUM
| *camel.component.aws-swf.secret Key* | Amazon AWS Secret Key. | null | ConfigDef.Importance.MEDIUM
| *camel.component.aws-swf.lazy StartProducer* | 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 | ConfigDef.Importance.MEDIUM
| *camel.component.aws-swf.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.component.aws-swf.configuration* | The AWS SWF default configuration | null | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END