Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.aws2.sns.Sns2Component>

All Known Implementing Classes:

Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilderImpl

Enclosing interface:

Aws2SnsComponentBuilderFactory
```
public static interface Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws2.sns.Sns2Component>
```
Builder for the AWS 2 Simple Notification System (SNS) component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`amazonSNSClient(software.amazon.awssdk.services.sns.SnsClient amazonSNSClient)` To use the AmazonSNS as the client.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`autoCreateTopic(boolean autoCreateTopic)` Setting the autocreation of the topic.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`configuration(org.apache.camel.component.aws2.sns.Sns2Configuration configuration)` Component configuration.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`kmsMasterKeyId(String kmsMasterKeyId)` The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`messageStructure(String messageStructure)` The message structure to use such as json.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`policy(String policy)` The policy for this queue.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the SNS client.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the SNS client.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)` To define a proxy protocol when instantiating the SNS client.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`queueUrl(String queueUrl)` The queueUrl to subscribe to.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`region(String region)` The region in which SNS client needs to work.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)` Define if Server Side Encryption is enabled or not on the topic.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`subject(String subject)` The subject which is used if the message header 'CamelAwsSnsSubject' is not present.
`default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder`	`subscribeSNStoSQS(boolean subscribeSNStoSQS)` Define if the subscription between SNS Topic and SQS must be done or not.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - amazonSNSClient
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder amazonSNSClient(software.amazon.awssdk.services.sns.SnsClient amazonSNSClient)
```
    To use the AmazonSNS as the client. The option is a: software.amazon.awssdk.services.sns.SnsClient type. Group: producer
  - autoCreateTopic
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder autoCreateTopic(boolean autoCreateTopic)
```
    Setting the autocreation of the topic. The option is a: boolean type. Default: true Group: producer
  - configuration
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder configuration(org.apache.camel.component.aws2.sns.Sns2Configuration configuration)
```
    Component configuration. The option is a: org.apache.camel.component.aws2.sns.Sns2Configuration type. Group: producer
  - kmsMasterKeyId
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder kmsMasterKeyId(String kmsMasterKeyId)
```
    The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. The option is a: java.lang.String type. Group: producer
  - lazyStartProducer
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder lazyStartProducer(boolean 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. The option is a: boolean type. Default: false Group: producer
  - messageStructure
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder messageStructure(String messageStructure)
```
    The message structure to use such as json. The option is a: java.lang.String type. Group: producer
  - policy
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder policy(String policy)
```
    The policy for this queue. The option is a: java.lang.String type. Group: producer
  - proxyHost
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder proxyHost(String proxyHost)
```
    To define a proxy host when instantiating the SNS client. The option is a: java.lang.String type. Group: producer
  - proxyPort
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder proxyPort(Integer proxyPort)
```
    To define a proxy port when instantiating the SNS client. The option is a: java.lang.Integer type. Group: producer
  - proxyProtocol
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the SNS client. The option is a: software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: producer
  - queueUrl
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder queueUrl(String queueUrl)
```
    The queueUrl to subscribe to. The option is a: java.lang.String type. Group: producer
  - region
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder region(String 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(). The option is a: java.lang.String type. Group: producer
  - serverSideEncryptionEnabled
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
```
    Define if Server Side Encryption is enabled or not on the topic. The option is a: boolean type. Default: false Group: producer
  - subject
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder subject(String subject)
```
    The subject which is used if the message header 'CamelAwsSnsSubject' is not present. The option is a: java.lang.String type. Group: producer
  - subscribeSNStoSQS
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder subscribeSNStoSQS(boolean subscribeSNStoSQS)
```
    Define if the subscription between SNS Topic and SQS must be done or not. The option is a: boolean type. Default: false Group: producer
  - basicPropertyBinding
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - accessKey
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
  - secretKey
```
default Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security

Interface Aws2SnsComponentBuilderFactory.Aws2SnsComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

amazonSNSClient

autoCreateTopic

configuration

kmsMasterKeyId

lazyStartProducer

messageStructure

policy

proxyHost

proxyPort

proxyProtocol

queueUrl

region

serverSideEncryptionEnabled

subject

subscribeSNStoSQS

basicPropertyBinding

accessKey

secretKey