| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for aws2-sns |
| |
| == Spring Boot Auto-Configuration |
| |
| When using aws2-sns 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-aws2-sns-starter</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel core version --> |
| </dependency> |
| ---- |
| |
| |
| The component supports 23 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *camel.component.aws2-sns.access-key* | Amazon AWS Access Key | | String |
| | *camel.component.aws2-sns.amazon-s-n-s-client* | To use the AmazonSNS as the client. The option is a software.amazon.awssdk.services.sns.SnsClient type. | | SnsClient |
| | *camel.component.aws2-sns.auto-create-topic* | Setting the autocreation of the topic | true | Boolean |
| | *camel.component.aws2-sns.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.aws2-sns.configuration* | Component configuration. The option is a org.apache.camel.component.aws2.sns.Sns2Configuration type. | | Sns2Configuration |
| | *camel.component.aws2-sns.enabled* | Whether to enable auto configuration of the aws2-sns component. This is enabled by default. | | Boolean |
| | *camel.component.aws2-sns.kms-master-key-id* | The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. | | String |
| | *camel.component.aws2-sns.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.aws2-sns.message-deduplication-id-strategy* | Only for FIFO Topic. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. | useExchangeId | String |
| | *camel.component.aws2-sns.message-group-id-strategy* | Only for FIFO Topic. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. | | String |
| | *camel.component.aws2-sns.message-structure* | The message structure to use such as json | | String |
| | *camel.component.aws2-sns.policy* | The policy for this queue | | String |
| | *camel.component.aws2-sns.proxy-host* | To define a proxy host when instantiating the SNS client | | String |
| | *camel.component.aws2-sns.proxy-port* | To define a proxy port when instantiating the SNS client | | Integer |
| | *camel.component.aws2-sns.proxy-protocol* | To define a proxy protocol when instantiating the SNS client | | Protocol |
| | *camel.component.aws2-sns.queue-url* | The queueUrl to subscribe to | | String |
| | *camel.component.aws2-sns.region* | The region in which SNS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() | | String |
| | *camel.component.aws2-sns.secret-key* | Amazon AWS Secret Key | | String |
| | *camel.component.aws2-sns.server-side-encryption-enabled* | Define if Server Side Encryption is enabled or not on the topic | false | Boolean |
| | *camel.component.aws2-sns.subject* | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. | | String |
| | *camel.component.aws2-sns.subscribe-s-n-sto-s-q-s* | Define if the subscription between SNS Topic and SQS must be done or not | false | Boolean |
| | *camel.component.aws2-sns.trust-all-certificates* | If we want to trust all certificates in case of overriding the endpoint | false | Boolean |
| | *camel.component.aws2-sns.use-default-credentials-provider* | Set whether the SNS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. | false | Boolean |
| |=== |
| // spring-boot-auto-configure options: END |
