| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for aws-sns |
| |
| == Spring Boot Auto-Configuration |
| |
| When using aws-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-aws-sns-starter</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel core version --> |
| </dependency> |
| ---- |
| |
| |
| The component supports 21 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *camel.component.aws-sns.access-key* | Amazon AWS Access Key | | String |
| | *camel.component.aws-sns.amazon-s-n-s-client* | To use the AmazonSNS as the client. The option is a com.amazonaws.services.sns.AmazonSNS type. | | AmazonSNS |
| | *camel.component.aws-sns.amazon-s-q-s-client* | An SQS Client to use as bridge between SNS and SQS. The option is a com.amazonaws.services.sqs.AmazonSQS type. | | AmazonSQS |
| | *camel.component.aws-sns.auto-create-topic* | Setting the autocreation of the topic | true | Boolean |
| | *camel.component.aws-sns.auto-discover-client* | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | Boolean |
| | *camel.component.aws-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.aws-sns.configuration* | The component configuration. The option is a org.apache.camel.component.aws.sns.SnsConfiguration type. | | SnsConfiguration |
| | *camel.component.aws-sns.enabled* | Whether to enable auto configuration of the aws-sns component. This is enabled by default. | | Boolean |
| | *camel.component.aws-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.aws-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.aws-sns.message-structure* | The message structure to use such as json | | String |
| | *camel.component.aws-sns.policy* | The policy for this queue | | String |
| | *camel.component.aws-sns.proxy-host* | To define a proxy host when instantiating the SNS client | | String |
| | *camel.component.aws-sns.proxy-port* | To define a proxy port when instantiating the SNS client | | Integer |
| | *camel.component.aws-sns.proxy-protocol* | To define a proxy protocol when instantiating the SNS client | | Protocol |
| | *camel.component.aws-sns.queue-url* | The queueUrl to subscribe to | | String |
| | *camel.component.aws-sns.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() | | String |
| | *camel.component.aws-sns.secret-key* | Amazon AWS Secret Key | | String |
| | *camel.component.aws-sns.server-side-encryption-enabled* | Define if Server Side Encryption is enabled or not on the topic | false | Boolean |
| | *camel.component.aws-sns.subject* | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. | | String |
| | *camel.component.aws-sns.subscribe-s-n-sto-s-q-s* | Define if the subscription between SNS Topic and SQS must be done or not | false | Boolean |
| |=== |
| // spring-boot-auto-configure options: END |
