Kamelets reference for Red Hat build of Apache Camel for Quarkus

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

table *

Table

Name of the DynamoDB table to look at

string

accessKey

Access Key

The access key obtained from AWS

string

operation

Operation

The operation to perform (one of PutItem, UpdateItem, DeleteItem)

string

"PutItem"

"PutItem"

overrideEndpoint

Endpoint Overwrite

Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting.

boolean

false

secretKey

Secret Key

The secret key obtained from AWS

string

uriEndpointOverride

Overwrite Endpoint URI

Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option.

string

useDefaultCredentialsProvider

Default Credentials Provider

Set whether the DynamoDB client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the DynamoDB client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the DynamoDB client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in DynamoDB.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string (password format)

schema *

Schema

The Avro schema to use during serialization (as single-line, using JSON format)

string

"{\"type\": \"record\", \"namespace\": \"com.example\", \"name\": \"FullName\", \"fields\": [{\"name\": \"first\", \"type\": \"string\"},{\"name\": \"last\", \"type\": \"string\"}]}"

validate

Validate

Indicates if the content must be validated against the schema

boolean

true

schema *

Schema

The Avro schema to use during serialization (as single-line, using JSON format)

string

"{\"type\": \"record\", \"namespace\": \"com.example\", \"name\": \"FullName\", \"fields\": [{\"name\": \"first\", \"type\": \"string\"},{\"name\": \"last\", \"type\": \"string\"}]}"

validate

Validate

Indicates if the content must be validated against the schema

boolean

true

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

stream *

Stream Name

The Kinesis stream that you want to access (needs to be created in advance)

string

accessKey

Access Key

The access key obtained from AWS

string

secretKey

Secret Key

The secret key obtained from AWS

string

useDefaultCredentialsProvider

Default Credentials Provider

If true, the Kinesis client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the Kinesis client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string (password format)

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

stream *

Stream Name

The Kinesis stream that you want to access (needs to be created in advance)

string

accessKey

Access Key

The access key obtained from AWS

string

secretKey

Secret Key

The secret key obtained from AWS

string

useDefaultCredentialsProvider

Default Credentials Provider

If true, the Kinesis client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the Kinesis client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string (password format)

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

delay

Delay

The number of milliseconds before the next poll of the selected stream.

integer

500

asyncClient

Async Client

If we want to a KinesisAsyncClient instance set it to true.

boolean

false

useKclConsumers

KCL Consumer

If we want to a KCL Consumer set it to true

boolean

false

function *

Function Name

The Lambda Function name

string

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

accessKey

Access Key

The access key obtained from AWS

string

secretKey

Secret Key

The secret key obtained from AWS

string

`

useDefaultCredentialsProvider

Default Credentials Provider

If true, the Lambda client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the Lambda client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the Lambda client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Lambda.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

databaseName *

Database Name

The Database Name we are pointing

string

query *

Query

The Query to execute against the AWS Redshift Database

string

"INSERT INTO accounts (username,city) VALUES (:#username,:#city)"

serverName *

Server Name

Server Name for the data source

string

"localhost"

username

Username

The username to use for accessing a secured AWS Redshift Database

string

password

Password

The password to use for accessing a secured AWS Redshift Database

string

serverPort

Server Port

Server Port for the data source

string

5439

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

topicNameOrArn *

Topic Name

The SQS Topic name or ARN

string

accessKey

Access Key

The access key obtained from AWS

string

secretKey

Secret Key

The secret key obtained from AWS

string

autoCreateTopic

Autocreate Topic

Setting the autocreation of the SNS topic.

boolean

false

useDefaultCredentialsProvider

Default Credentials Provider

If true, the SNS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the SNS client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the SNS client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in SNS.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string (password format)

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

queueNameOrArn *

Queue Name

The SQS Queue name or ARN

string

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

accessKey

Access Key

The access key obtained from AWS

string

secretKey

Secret Key

The secret key obtained from AWS

string

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

false

amazonAWSHost

AWS Host

The hostname of the Amazon AWS cloud.

string

amazonaws.com

protocol

Protocol

The underlying protocol used to communicate with SQS.

string

https

http or https

useDefaultCredentialsProvider

Default Credentials Provider

If true, the SQS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the SQS client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the SQS client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in SQS.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string (password format)

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

queueNameOrArn *

Queue Name

The SQS Queue name or ARN

string

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

accessKey

Access Key

The access key obtained from AWS

string

secretKey

Secret Key

The secret key obtained from AWS

string

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

false

deleteAfterRead

Auto-delete Messages

Delete messages after consuming them

boolean

true

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

false

amazonAWSHost

AWS Host

The hostname of the Amazon AWS cloud.

string

amazonaws.com

protocol

Protocol

The underlying protocol used to communicate with SQS

string

https

http or https

queueURL

Queue URL

The full SQS Queue URL (required if using KEDA)

string

useDefaultCredentialsProvider

Default Credentials Provider

If true, the SQS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the SQS client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the SQS client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in SQS.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string (password format)

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

delay

Delay

The number of milliseconds before the next poll of the selected stream

integer

500

greedy

Greedy Scheduler

If greedy is enabled, then the polling will happen immediately again, if the previous run polled 1 or more messages.

boolean

false

maxMessagesPerPoll

Max Messages Per Poll

The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values 1 to 10. Default 1.

integer

`1 (minimum: 1, maximum: 10)`

waitTimeSeconds

Wait Time Seconds

The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call does not return a message list.

integer

minimum: `0`

visibilityTimeout

Visibility Timeout

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

integer

minimum: `0`

queueNameOrArn *

Queue Name

The SQS Queue name or ARN

string

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

accessKey

Access Key

The access key obtained from AWS

string

secretKey

Secret Key

The secret key obtained from AWS

string

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

false

contentBasedDeduplication

Content-Based Deduplication

Use content-based deduplication (should be enabled in the SQS FIFO queue first)

boolean

false

contentBasedDeduplication

Content-Based Deduplication

Use content-based deduplication (should be enabled in the SQS FIFO queue first)

boolean

false

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

false

amazonAWSHost

AWS Host

The hostname of the Amazon AWS cloud.

string

amazonaws.com

protocol

Protocol

The underlying protocol used to communicate with SQS

string

https

http or https

useDefaultCredentialsProvider

Default Credentials Provider

Set whether the SQS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the SQS client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the SQS client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in SQS.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string

password

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

bucketNameOrArn *

Bucket Name

The S3 Bucket name or ARN.

string

region *

AWS Region

The AWS region to connect to.

string

"eu-west-1"

accessKey

Access Key

The access key obtained from AWS.

string

secretKey

Secret Key

The secret key obtained from AWS.

string

autoCreateBucket

Autocreate Bucket

Setting the autocreation of the S3 bucket bucketName.

boolean

false

useDefaultCredentialsProvider

Default Credentials Provider

If true, the S3 client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the S3 client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the S3 client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in S3.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string

password

uriEndpointOverride

Overwrite Endpoint URI

` The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

forcePathStyle

Force Path Style

Forces path style when accessing AWS S3 buckets.

boolean

false

keyName

Key Name

The key name for saving an element in the bucket.

string

bucketNameOrArn *

Bucket Name

The S3 Bucket name or ARN

string

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

accessKey

Access Key

The access key obtained from AWS

string

secretKey

Secret Key

The secret key obtained from AWS

string

autoCreateBucket

Autocreate Bucket

Setting the autocreation of the S3 bucket bucketName.

boolean

false

deleteAfterRead

Auto-delete Objects

Delete objects after consuming them

boolean

true

moveAfterRead

Move Objects After Delete

Move objects from S3 bucket to a different bucket after they have been retrieved.

boolean

false

destinationBucket

Destination Bucket

Define the destination bucket where an object must be moved when moveAfterRead is set to true.

string

destinationBucketPrefix

Destination Bucket Prefix

Define the destination bucket prefix to use when an object must be moved, and moveAfterRead is set to true.

string

destinationBucketSuffix

Destination Bucket Suffix

Define the destination bucket suffix to use when an object must be moved, and moveAfterRead is set to true.

string

accessKey

Access Key

The access key obtained from AWS.

string

password

secretKey

Secret Key

The secret key obtained from AWS.

string

password

autoCreateBucket

Autocreate Bucket

Specifies to automatically create the S3 bucket.

boolean

false

prefix

Prefix

The AWS S3 bucket prefix to consider while searching.

string

'folder/'

ignoreBody

Ignore Body

If true, the S3 Object body is ignored. Setting this to true overrides any behavior defined by the includeBody option. If false, the S3 object is put in the body.

boolean

false

useDefaultCredentialsProvider

Default Credentials Provider

If true, the S3 client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the S3 client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the S3 client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in S3.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string

password

uriEndpointOverride

Overwrite Endpoint URI

` The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

forcePathStyle

Force Path Style

Forces path style when accessing AWS S3 buckets.

boolean

false

delay

Delay

The number of milliseconds before the next poll of the selected bucket.

integer

500

maxMessagesPerPoll

Max Messages Per Poll

Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited.

integer

10

accessKey

Access Key

The access key obtained from AWS.

string

bucketNameOrArn *

Bucket Name

The S3 Bucket name or ARN.

string

keyName *

Key Name

Setting the key name for an element in the bucket through endpoint parameter. In Streaming Upload, with the default configuration, this will be the base for the progressive creation of files.

string

region *

AWS Region

The AWS region to connect to.

string

"eu-west-1"

secretKey

Secret Key

The secret key obtained from AWS.

string

autoCreateBucket

Autocreate Bucket

Setting the autocreation of the S3 bucket bucketName.

boolean

false

autoCreateBucket

Autocreate Bucket

Setting the autocreation of the S3 bucket bucketName.

boolean

false

restartingPolicy

Restarting Policy

The restarting policy to use in streaming upload mode. There are 2 enums and the value can be one of override, lastPart

string

"lastPart"

batchMessageNumber

Batch Message Number

The number of messages composing a batch in streaming upload mode

integer

10

batchSize

Batch Size

The batch size (in bytes) in streaming upload mode

integer

1000000

streamingUploadTimeout

Streaming Upload Timeout

While streaming upload mode is true, this option set the timeout to complete upload

integer

namingStrategy

Naming Strategy

The naming strategy to use in streaming upload mode. There are 2 enums and the value can be one of progressive, random

string

"progressive"

keyName

Key Name

Setting the key name for an element in the bucket through endpoint parameter. In Streaming Upload, with the default configuration, this will be the base for the progressive creation of files.

string

useDefaultCredentialsProvider

Default Credentials Provider

Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the S3 client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the S3 client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in S3.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string

password

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

forcePathStyle

Force Path Style

Forces path style when accessing AWS S3 buckets.

boolean

false

connectionHost *

Connection Host

Hostname(s) cassandra server(s). Multiple hosts can be separated by comma.

string

"localhost"

connectionPort *

Connection Port

Port number of cassandra server(s)

string

9042

keyspace *

Keyspace

Keyspace to use

string

"customers"

query *

Query

The query to execute against the Cassandra cluster table

string

password

Password

The password to use for accessing a secured Cassandra Cluster

string

username

Username

The username to use for accessing a secured Cassandra Cluster

string

consistencyLevel

Consistency Level

Consistency level to use. The value can be one of ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE

string

"ANY"

prepareStatements

Prepare Statements

If true, specifies to use PreparedStatements as the query. If false, specifies to use regular Statements as the query.

boolean

true

extraTypeCodecs

Extra Type Codecs

To use a specific comma separated list of Extra Type codecs.

string

"BLOB_TO_ARRAY"

jsonPayload

JSON Payload

If we want to transform the payload in json or not

boolean

true

connectionHost *

Connection Host

Hostname(s) cassandra server(s). Multiple hosts can be separated by comma.

string

"localhost"

connectionPort *

Connection Port

Port number of cassandra server(s)

string

9042

keyspace *

Keyspace

Keyspace to use

string

"customers"

query *

Query

The query to execute against the Cassandra cluster table

string

password

Password

The password to use for accessing a secured Cassandra Cluster

string

username

Username

The username to use for accessing a secured Cassandra Cluster

string

consistencyLevel

Consistency Level

Consistency level to use. The value can be one of ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE

string

"QUORUM"

resultStrategy

Result Strategy

The strategy to convert the result set of the query. Possible values are ALL, ONE, LIMIT_10, LIMIT_100…​

string

"ALL"

extraTypeCodecs

Extra Type Codecs

To use a specific comma separated list of Extra Type codecs.

string

"BLOB_TO_ARRAY"

bucketName *

Bucket Name

The Ceph Bucket name.

string

cephUrl *

Ceph Url Address

Set the Ceph Object Storage Address Url.

string

"http://ceph-storage-address.com"

zoneGroup *

Bucket Zone Group

The bucket zone group.

string

accessKey

Access Key

The access key.

string

secretKey

Secret Key

The secret key.

string

autoCreateBucket

Autocreate Bucket

Specifies to automatically create the bucket.

boolean

false

keyName

Key Name

The key name for saving an element in the bucket.

string

bucketName *

Bucket Name

The Ceph Bucket name.

string

cephUrl *

Ceph Url Address

Set the Ceph Object Storage Address Url.

string

"http://ceph-storage-address.com"

zoneGroup *

Bucket Zone Group

The bucket zone group.

string

accessKey

Access Key

The access key.

string

secretKey

Secret Key

The secret key.

string

autoCreateBucket

Autocreate Bucket

Specifies to automatically create the bucket.

boolean

false

delay

Delay

The number of milliseconds before the next poll of the selected bucket.

integer

500

deleteAfterRead

Auto-delete Objects

Specifies to delete objects after consuming them.

boolean

true

ignoreBody

Ignore Body

If true, the Object body is ignored. Setting this to true overrides any behavior defined by the includeBody option. If false, the object is put in the body.

boolean

false

includeBody

Include Body

If true, the exchange is consumed and put into the body and closed. If false, the Object stream is put raw into the body and the headers are set with the object metadata.

boolean

true

prefix

Prefix

The bucket prefix to consider while searching.

string

"folder/"

field *

Field

The name of the field to be added

string

headerOutput

Header Output

If enable the action will store the extracted field in an header named CamelKameletsExtractFieldName

boolean

false

headerOutputName

Header Output Name

A custom name for the header containing the extracted field

string

"none"

strictHeaderCheck

Strict Header Check

If enabled the action will check if the header output name (custom or default) has been used already in the exchange. If so, the extracted field will be stored in the message body, if not, the extracted field will be stored in the selected header (custom or default).

boolean

false

trimField

Trim Field

If enabled we return the Raw extracted field

boolean

false

connectionHost *

Connection Host

Hostname of the FTP server

string

connectionPort *

Connection Port

Port of the FTP server

string

21

directoryName *

Directory Name

The starting directory

string

password

Password

The password to access the FTP server

string

username

Username

The username to access the FTP server

string

fileExist

File Existence

How to behave in case of file already existent. There are 4 enums and the value can be one of Override, Append, Fail or Ignore

string

"Override"

passiveMode

Passive Mode

Sets passive mode connection

boolean

false

binary

Binary

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).

boolean

false

autoCreate

Autocreate Missing Directories

Automatically create starting directory.

boolean

true

delete

Delete

If true, the file will be deleted after it is processed successfully.

boolean

false

connectionHost *

Connection Host

Hostname of the FTP server

string

connectionPort *

Connection Port

Port of the FTP server

string

21

directoryName *

Directory Name

The starting directory

string

password

Password

The password to access the FTP server

string

username

Username

The username to access the FTP server

string

idempotent

Idempotency

Skip already processed files.

boolean

true

passiveMode

Passive Mode

Sets passive mode connection

boolean

false

recursive

Recursive

If a directory, will look for files in all the subdirectories as well.

boolean

false

binary

Binary

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).

boolean

false

autoCreate

Autocreate Missing Directories

Automatically create starting directory.

boolean

true

delete

Delete

If true, the file will be deleted after it is processed successfully.

boolean

false

connectionHost *

Connection Host

Hostname of the FTP server

string

connectionPort *

Connection Port

Port of the FTP server

string

21

directoryName *

Directory Name

The starting directory

string

password

Password

The password to access the FTP server

string

username

Username

The username to access the FTP server

string

fileExist

File Existence

How to behave in case of file already existent. There are 4 enums and the value can be one of Override, Append, Fail or Ignore

string

"Override"

passiveMode

Passive Mode

Sets passive mode connection

boolean

false

binary

Binary

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).

boolean

false

autoCreate

Autocreate Missing Directories

Automatically create starting directory.

boolean

true

delete

Delete

If true, the file will be deleted after it is processed successfully.

boolean

false

connectionHost *

Connection Host

Hostname of the FTPS server

string

connectionPort *

Connection Port

Port of the FTPS server

string

21

directoryName *

Directory Name

The starting directory

string

password

Password

The password to access the FTPS server

string

username

Username

The username to access the FTPS server

string

idempotent

Idempotency

Skip already processed files.

boolean

true

passiveMode

Passive Mode

Sets passive mode connection

boolean

false

recursive

Recursive

If a directory, will look for files in all the subdirectories as well.

boolean

false

binary

Binary

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).

boolean

false

autoCreate

Autocreate Missing Directories

Automatically create starting directory.

boolean

true

delete

Delete

If true, the file will be deleted after it is processed successfully.

boolean

false

name *

Header Name

The header name to evaluate. The header name must be passed by the source Kamelet. For Knative only, if you are using Cloud Events, you must include the CloudEvent (ce-) prefix in the header name.

string

"headerName"

value

Header Value

An optional header value to compare the header to.

string

headerValue

field *

Field

The name of the field that will contain the event

string

url *

URL

The URL to send data to

string

"https://my-service/path"

method

Method

The HTTP method to use

string

"POST"

field *

Field

The name of the field to be added

string

value *

Value

The value of the field

string

name *

Name

The name of the header to be added. For Knative only, the name of the header requires a CloudEvent (ce-) prefix.

string

value *

Value

The value of the header

string

jiraUrl *

Jira URL

The URL of your instance of Jira

string

"http://my_jira.com:8081"

password

Password

The password or the API Token to access Jira

string

username

Username

The username to access Jira

string

personal-token

Personal Token

Personal Token

string

jiraUrl *

Jira URL

The URL of your instance of Jira

string

"http://my_jira.com:8081"

password

Password

The password or the API Token to access Jira

string

username

Username

The username to access Jira

string

personal-token

Personal Token

Personal Token

string

jiraUrl *

Jira URL

The URL of your instance of Jira

string

"http://my_jira.com:8081"

password

Password

The password or the API Token to access Jira

string

username

Username

The username to access Jira

string

personal-token

Personal Token

Personal Token

string

jiraUrl *

Jira URL

The URL of your instance of Jira

string

"http://my_jira.com:8081"

password

Password

The password or the API Token to access Jira

string

username

Username

The username to access Jira

string

personal-token

Personal Token

Personal Token

string

jiraUrl *

Jira URL

The URL of your instance of Jira

string

"http://my_jira.com:8081"

password

Password

The password to access Jira

string

username

Username

The username to access Jira

string

jql

JQL

A query to filter issues

string

"project=MyProject"

personal-token

Personal Token

Personal Token

string

destinationName *

Destination Name

The JMS destination name

string

remoteURI *

Broker URL

The JMS URL

string

"amqp://my-host:31616"

destinationType

Destination Type

The JMS destination type (i.e.: queue or topic)

string

"queue"

destinationName *

Destination Name

The JMS destination name

string

remoteURI *

Broker URL

The JMS URL

string

"amqp://my-host:31616"

destinationType

Destination Type

The JMS destination type (i.e.: queue or topic)

string

"queue"

channel *

IBM MQ Channel

Name of the IBM MQ Channel

string

destinationName *

Destination Name

The destination name

string

queueManager *

IBM MQ Queue Manager

Name of the IBM MQ Queue Manager

string

serverName *

IBM MQ Server name

IBM MQ Server name or address

string

serverPort *

IBM MQ Server Port

IBM MQ Server port

integer

1414

password

Password

Password to authenticate to IBM MQ server

string

username

Username

Username to authenticate to IBM MQ server

string

clientId

IBM MQ Client ID

Name of the IBM MQ Client ID

string

destinationType

Destination Type

The JMS destination type (queue or topic)

string

"queue"

channel *

IBM MQ Channel

Name of the IBM MQ Channel

string

destinationName *

Destination Name

The destination name

string

queueManager *

IBM MQ Queue Manager

Name of the IBM MQ Queue Manager

string

serverName *

IBM MQ Server name

IBM MQ Server name or address

string

serverPort *

IBM MQ Server Port

IBM MQ Server port

integer

1414

password

Password

Password to authenticate to IBM MQ server

string

username

Username

Username to authenticate to IBM MQ server

string

clientId

IBM MQ Client ID

Name of the IBM MQ Client ID

string

destinationType

Destination Type

The JMS destination type (queue or topic)

string

"queue"

sslCipherSuite

CipherSuite

CipherSuite to use for enabling TLS

string

template *

Template

The inline template for JSLT Transformation

string

"file://template.json"

bootstrapServers *

Brokers

Comma separated list of Kafka Broker URLs

string

topic *

Topic Names

Comma separated list of Kafka topic names

string

user *

Username

Username to authenticate to Kafka

string

password

Password

Password to authenticate to kafka

string

saslMechanism

SASL Mechanism

The Simple Authentication and Security Layer (SASL) Mechanism used.

string

"PLAIN"

securityProtocol

Security Protocol

Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported

string

"SASL_SSL"

topic *

Topic Names

Comma separated list of Kafka topic names

string

bootstrapServers *

Brokers

Comma separated list of Kafka Broker URLs

string

user *

Username

Username to authenticate to Kafka

string

password *

Password

Password to authenticate to kafka

string

securityProtocol

Security Protocol

Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported

string

"SASL_SSL"

saslMechanism

SASL Mechanism

The Simple Authentication and Security Layer (SASL) Mechanism used.

string

"PLAIN"

autoCommitEnable

Auto Commit Enable

If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer.

boolean

true

allowManualCommit

Allow Manual Commit

Whether to allow doing manual commits

boolean

false

autoOffsetReset

Auto Offset Reset

What to do when there is no initial offset. There are 3 enums and the value can be one of latest, earliest, none

string

"latest"

pollOnError

Poll On Error Behavior

What to do if kafka threw an exception while polling for new messages. There are 5 enums and the value can be one of DISCARD, ERROR_HANDLER, RECONNECT, RETRY, STOP

string

"ERROR_HANDLER"

deserializeHeaders

Automatically Deserialize Headers

When enabled the Kamelet source will deserialize all message headers to String representation. The default is false.

boolean

true

consumerGroup

Consumer Group

A string that uniquely identifies the group of consumers to which this source belongs

string

"my-group-id"

topicIsPattern

Topic Is Pattern

Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern.

boolean

false

regex *

Regex

The Regex to Evaluate against the Kafka topic name

string

loggerName

Logger Name

Name of the logging category to use

string

"log-sink"

level

Log Level

Logging level to use

string

"INFO"

"TRACE"

logMask

Log Mask

Mask sensitive information like password or passphrase in the log

boolean

false

marker

Marker

An optional Marker name to use

string

multiline

Multiline

If enabled then each information is outputted on a newline

boolean

false

showAllProperties

Show All Properties

Show all of the exchange properties (both internal and custom)

boolean

false

showBody

Show Body

Show the message body

boolean

true

showBodyType

Show Body Type

Show the body Java type

boolean

true

showExchangePattern

Show Exchange Pattern

Shows the Message Exchange Pattern (or MEP for short)

boolean

true

showHeaders

Show Headers

Show the headers received

boolean

false

showProperties

Show Properties

Show the exchange properties (only custom). Use showAllProperties to show both internal and custom properties.

boolean

false

showStreams

Show Streams

Show the stream bodies (they may not be available in following steps)

boolean

false

showCachedStreams

Show Cached Streams

Whether Camel should show cached stream bodies or not.

boolean

true

databaseName *

Database Name

The Database Name we are pointing

string

query *

Query

The Query to execute against the MariaDB Database

string

"INSERT INTO accounts (username,city) VALUES (:#username,:#city)"

serverName *

Server Name

Server Name for the data source

string

"localhost"

password

Password

The password to use for accessing a secured MariaDB Database

string

username

Username

The username to use for accessing a secured MariaDB Database

string

serverPort

Server Port

Server Port for the data source

string

3306

fields *

Fields

Comma separated list of fields to mask

string

replacement *

Replacement

Replacement for the fields to be masked

string

timestampKeys *

Timestamp Keys

Comma separated list of Timestamp keys. The timestamp is taken from the first found field.

string

timestampFormat

Timestamp Format

Format string for the timestamp that is compatible with java.text.SimpleDateFormat.

string

"yyyyMMdd"

timestampKeyFormat

Timestamp Keys Format

Format of the timestamp keys. Possible values are 'timestamp' or any format string for the timestamp that is compatible with java.text.SimpleDateFormat. In case of 'timestamp' the field will be evaluated as milliseconds since 1970, so as a UNIX Timestamp.

string

"timestamp"

topicFormat

Topic Format

Format string which can contain '$[topic]' and '$[timestamp]' as placeholders for the topic and timestamp, respectively.

string

"topic-$[timestamp]"

collection *

MongoDB Collection

Sets the name of the MongoDB collection to bind to this endpoint.

string

database *

MongoDB Database

Sets the name of the MongoDB database to target.

string

hosts *

MongoDB Hosts

Comma separated list of MongoDB Host Addresses in host:port format.

string

createCollection

Collection

Create collection during initialisation if it doesn’t exist.

boolean

false

password

MongoDB Password

User password for accessing MongoDB.

string

username

MongoDB Username

Username for accessing MongoDB.

string

writeConcern

Write Concern

Configure the level of acknowledgment requested from MongoDB for write operations, possible values are ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED, MAJORITY.

string

ssl

Enable Ssl for Mongodb Connection

whether to enable ssl connection to mongodb

boolean

true

sslValidationEnabled

Enables Ssl Certificates Validation and Host name checks.

IMPORTANT this should be disabled only in test environment since can pose security issues.

boolean

true

collection *

MongoDB Collection

Sets the name of the MongoDB collection to bind to this endpoint.

string

database *

MongoDB Database

Sets the name of the MongoDB database to target.

string

hosts *

MongoDB Hosts

Comma separated list of MongoDB Host Addresses in host:port format.

string

password

MongoDB Password

User password for accessing MongoDB.

string

username

MongoDB Username

Username for accessing MongoDB. The username must be present in the MongoDB’s authentication database (authenticationDatabase). By default, the MongoDB authenticationDatabase is 'admin'.

string

persistentTailTracking

MongoDB Persistent Tail Tracking

Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records.

boolean

false

tailTrackIncreasingField

MongoDB Tail Track Increasing Field

Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated.

string

ssl

Enable Ssl for Mongodb Connection

whether to enable ssl connection to mongodb

boolean

true