| // kafka-connector options: START |
| [[camel-aws-sns-kafka-connector-sink]] |
| = camel-aws-sns-kafka-connector sink configuration |
| |
| When using camel-aws-sns-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-sns-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-aws-sns sink connector supports 27 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.topicNameOrArn* | Topic name or ARN | null | HIGH |
| | *camel.sink.endpoint.amazonSNSClient* | To use the AmazonSNS as the client | null | MEDIUM |
| | *camel.sink.endpoint.amazonSQSClient* | An SQS Client to use as bridge between SNS and SQS | null | MEDIUM |
| | *camel.sink.endpoint.autoCreateTopic* | Setting the autocreation of the topic | true | MEDIUM |
| | *camel.sink.endpoint.headerFilterStrategy* | To use a custom HeaderFilterStrategy to map headers to/from Camel. | null | MEDIUM |
| | *camel.sink.endpoint.kmsMasterKeyId* | The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. | null | 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 | MEDIUM |
| | *camel.sink.endpoint.messageStructure* | The message structure to use such as json | null | MEDIUM |
| | *camel.sink.endpoint.policy* | The policy for this queue | null | MEDIUM |
| | *camel.sink.endpoint.proxyHost* | To define a proxy host when instantiating the SNS client | null | MEDIUM |
| | *camel.sink.endpoint.proxyPort* | To define a proxy port when instantiating the SNS client | null | MEDIUM |
| | *camel.sink.endpoint.proxyProtocol* | To define a proxy protocol when instantiating the SNS client One of: [HTTP] [HTTPS] | "HTTPS" | MEDIUM |
| | *camel.sink.endpoint.queueUrl* | The queueUrl to subscribe to | null | MEDIUM |
| | *camel.sink.endpoint.region* | The region in which SNS client needs to work. 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.sink.endpoint.serverSideEncryptionEnabled* | Define if Server Side Encryption is enabled or not on the topic | false | MEDIUM |
| | *camel.sink.endpoint.subject* | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. | null | MEDIUM |
| | *camel.sink.endpoint.subscribeSNStoSQS* | Define if the subscription between SNS Topic and SQS must be done or not | false | MEDIUM |
| | *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM |
| | *camel.sink.endpoint.accessKey* | Amazon AWS Access Key | null | MEDIUM |
| | *camel.sink.endpoint.secretKey* | Amazon AWS Secret Key | null | MEDIUM |
| | *camel.component.aws-sns.accessKey* | Amazon AWS Access Key | null | MEDIUM |
| | *camel.component.aws-sns.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 | MEDIUM |
| | *camel.component.aws-sns.region* | The region in which SNS client needs to work | null | MEDIUM |
| | *camel.component.aws-sns.secretKey* | Amazon AWS Secret Key | null | MEDIUM |
| | *camel.component.aws-sns.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-sns.configuration* | The AWS SNS default configuration | null | MEDIUM |
| |=== |
| // kafka-connector options: END |
