camel-aws-swf-kafka-connector sink configuration

Connector Description: Manage workflows in the AWS Simple Workflow service.

When using camel-aws-swf-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<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>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.awsswf.CamelAwsswfSinkConnector

The camel-aws-swf sink connector supports 45 options, which are listed below.

Name Description Default Required Priority

camel.sink.path.type

Activity or workflow One of: [activity] [workflow]

null

true

HIGH

camel.sink.endpoint.amazonSWClient

To use the given AmazonSimpleWorkflowClient as client

null

false

MEDIUM

camel.sink.endpoint.dataConverter

An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data.

null

false

MEDIUM

camel.sink.endpoint.domainName

The workflow domain to use.

null

false

MEDIUM

camel.sink.endpoint.eventName

The workflow or activity event name to use.

null

false

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

false

MEDIUM

camel.sink.endpoint.version

The workflow or activity event version to use.

null

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

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

false

MEDIUM

camel.sink.endpoint.activitySchedulingOptions

Activity scheduling options

null

false

MEDIUM

camel.sink.endpoint.clientConfigurationParameters

To configure the ClientConfiguration using the key/values from the Map.

null

false

MEDIUM

camel.sink.endpoint.startWorkflowOptionsParameters

To configure the StartWorkflowOptions using the key/values from the Map.

null

false

MEDIUM

camel.sink.endpoint.sWClientParameters

To configure the AmazonSimpleWorkflowClient using the key/values from the Map.

null

false

MEDIUM

camel.sink.endpoint.accessKey

Amazon AWS Access Key.

null

false

MEDIUM

camel.sink.endpoint.secretKey

Amazon AWS Secret Key.

null

false

MEDIUM

camel.sink.endpoint.childPolicy

The policy to use on child workflows when terminating a workflow.

null

false

MEDIUM

camel.sink.endpoint.executionStartToCloseTimeout

Set the execution start to close timeout.

"3600"

false

MEDIUM

camel.sink.endpoint.operation

Workflow operation One of: [SIGNAL] [CANCEL] [TERMINATE] [GET_STATE] [START] [DESCRIBE] [GET_HISTORY]

"START"

false

MEDIUM

camel.sink.endpoint.signalName

The name of the signal to send to the workflow.

null

false

MEDIUM

camel.sink.endpoint.stateResultType

The type of the result when a workflow state is queried.

null

false

MEDIUM

camel.sink.endpoint.taskStartToCloseTimeout

Set the task start to close timeout.

"600"

false

MEDIUM

camel.sink.endpoint.terminationDetails

Details for terminating a workflow.

null

false

MEDIUM

camel.sink.endpoint.terminationReason

The reason for terminating a workflow.

null

false

MEDIUM

camel.component.aws-swf.amazonSWClient

To use the given AmazonSimpleWorkflowClient as client

null

false

MEDIUM

camel.component.aws-swf.configuration

The component configuration

null

false

MEDIUM

camel.component.aws-swf.dataConverter

An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data.

null

false

MEDIUM

camel.component.aws-swf.domainName

The workflow domain to use.

null

false

MEDIUM

camel.component.aws-swf.eventName

The workflow or activity event name to use.

null

false

MEDIUM

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()

null

false

MEDIUM

camel.component.aws-swf.version

The workflow or activity event version to use.

null

false

MEDIUM

camel.component.aws-swf.lazyStartProducer

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

false

MEDIUM

camel.component.aws-swf.activitySchedulingOptions

Activity scheduling options

null

false

MEDIUM

camel.component.aws-swf.autowiredEnabled

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

false

MEDIUM

camel.component.aws-swf.clientConfiguration Parameters

To configure the ClientConfiguration using the key/values from the Map.

null

false

MEDIUM

camel.component.aws-swf.startWorkflowOptions Parameters

To configure the StartWorkflowOptions using the key/values from the Map.

null

false

MEDIUM

camel.component.aws-swf.sWClientParameters

To configure the AmazonSimpleWorkflowClient using the key/values from the Map.

null

false

MEDIUM

camel.component.aws-swf.accessKey

Amazon AWS Access Key.

null

false

MEDIUM

camel.component.aws-swf.secretKey

Amazon AWS Secret Key.

null

false

MEDIUM

camel.component.aws-swf.childPolicy

The policy to use on child workflows when terminating a workflow.

null

false

MEDIUM

camel.component.aws-swf.executionStartToClose Timeout

Set the execution start to close timeout.

"3600"

false

MEDIUM

camel.component.aws-swf.operation

Workflow operation One of: [SIGNAL] [CANCEL] [TERMINATE] [GET_STATE] [START] [DESCRIBE] [GET_HISTORY]

"START"

false

MEDIUM

camel.component.aws-swf.signalName

The name of the signal to send to the workflow.

null

false

MEDIUM

camel.component.aws-swf.stateResultType

The type of the result when a workflow state is queried.

null

false

MEDIUM

camel.component.aws-swf.taskStartToCloseTimeout

Set the task start to close timeout.

"600"

false

MEDIUM

camel.component.aws-swf.terminationDetails

Details for terminating a workflow.

null

false

MEDIUM

camel.component.aws-swf.terminationReason

The reason for terminating a workflow.

null

false

MEDIUM

The camel-aws-swf sink connector has no converters out of the box.

The camel-aws-swf sink connector has no transforms out of the box.

The camel-aws-swf sink connector has no aggregation strategies out of the box.