| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for aws-swf |
| |
| == Spring Boot Auto-Configuration |
| |
| When using aws-swf 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-swf-starter</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel core version --> |
| </dependency> |
| ---- |
| |
| |
| The component supports 31 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *camel.component.aws-swf.access-key* | Amazon AWS Access Key. | | String |
| | *camel.component.aws-swf.activity-list* | The list name to consume activities from. | | String |
| | *camel.component.aws-swf.activity-scheduling-options* | Activity scheduling options. The option is a com.amazonaws.services.simpleworkflow.flow.ActivitySchedulingOptions type. | | ActivitySchedulingOptions |
| | *camel.component.aws-swf.activity-thread-pool-size* | Maximum number of threads in work pool for activity. | 100 | Integer |
| | *camel.component.aws-swf.activity-type-execution-options* | Activity execution options. The option is a com.amazonaws.services.simpleworkflow.flow.worker.ActivityTypeExecutionOptions type. | | ActivityTypeExecutionOptions |
| | *camel.component.aws-swf.activity-type-registration-options* | Activity registration options. The option is a com.amazonaws.services.simpleworkflow.flow.worker.ActivityTypeRegistrationOptions type. | | ActivityTypeRegistrationOptions |
| | *camel.component.aws-swf.amazon-s-w-client* | To use the given AmazonSimpleWorkflowClient as client. The option is a com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow type. | | AmazonSimpleWorkflow |
| | *camel.component.aws-swf.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-swf.bridge-error-handler* | 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 | Boolean |
| | *camel.component.aws-swf.child-policy* | The policy to use on child workflows when terminating a workflow. | | String |
| | *camel.component.aws-swf.client-configuration-parameters* | To configure the ClientConfiguration using the key/values from the Map. | | Map |
| | *camel.component.aws-swf.configuration* | The component configuration. The option is a org.apache.camel.component.aws.swf.SWFConfiguration type. | | SWFConfiguration |
| | *camel.component.aws-swf.data-converter* | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. The option is a com.amazonaws.services.simpleworkflow.flow.DataConverter type. | | DataConverter |
| | *camel.component.aws-swf.domain-name* | The workflow domain to use. | | String |
| | *camel.component.aws-swf.enabled* | Whether to enable auto configuration of the aws-swf component. This is enabled by default. | | Boolean |
| | *camel.component.aws-swf.event-name* | The workflow or activity event name to use. | | String |
| | *camel.component.aws-swf.execution-start-to-close-timeout* | Set the execution start to close timeout. | 3600 | String |
| | *camel.component.aws-swf.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-swf.operation* | Workflow operation | START | String |
| | *camel.component.aws-swf.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() | | String |
| | *camel.component.aws-swf.s-w-client-parameters* | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | | Map |
| | *camel.component.aws-swf.secret-key* | Amazon AWS Secret Key. | | String |
| | *camel.component.aws-swf.signal-name* | The name of the signal to send to the workflow. | | String |
| | *camel.component.aws-swf.start-workflow-options-parameters* | To configure the StartWorkflowOptions using the key/values from the Map. | | Map |
| | *camel.component.aws-swf.state-result-type* | The type of the result when a workflow state is queried. | | String |
| | *camel.component.aws-swf.task-start-to-close-timeout* | Set the task start to close timeout. | 600 | String |
| | *camel.component.aws-swf.termination-details* | Details for terminating a workflow. | | String |
| | *camel.component.aws-swf.termination-reason* | The reason for terminating a workflow. | | String |
| | *camel.component.aws-swf.version* | The workflow or activity event version to use. | | String |
| | *camel.component.aws-swf.workflow-list* | The list name to consume workflows from. | | String |
| | *camel.component.aws-swf.workflow-type-registration-options* | Workflow registration options. The option is a com.amazonaws.services.simpleworkflow.flow.WorkflowTypeRegistrationOptions type. | | WorkflowTypeRegistrationOptions |
| |=== |
| // spring-boot-auto-configure options: END |
