Interface AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
-
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws.sns.SnsComponent>
- All Known Implementing Classes:
AwsSnsComponentBuilderFactory.AwsSnsComponentBuilderImpl
- Enclosing interface:
- AwsSnsComponentBuilderFactory
public static interface AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws.sns.SnsComponent>
Builder for the AWS Simple Notification System (SNS) component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
accessKey(String accessKey)
Amazon AWS Access Key.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
amazonSNSClient(com.amazonaws.services.sns.AmazonSNS amazonSNSClient)
To use the AmazonSNS as the client.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
amazonSQSClient(com.amazonaws.services.sqs.AmazonSQS amazonSQSClient)
An SQS Client to use as bridge between SNS and SQS.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
autoCreateTopic(boolean autoCreateTopic)
Setting the autocreation of the topic.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
autoDiscoverClient(boolean autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
configuration(org.apache.camel.component.aws.sns.SnsConfiguration configuration)
The component configuration.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
kmsMasterKeyId(String kmsMasterKeyId)
The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
messageStructure(String messageStructure)
The message structure to use such as json.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
policy(String policy)
The policy for this queue.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
proxyHost(String proxyHost)
To define a proxy host when instantiating the SNS client.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SNS client.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
proxyProtocol(com.amazonaws.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SNS client.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
queueUrl(String queueUrl)
The queueUrl to subscribe to.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
region(String region)
The region in which SNS client needs to work.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
secretKey(String secretKey)
Amazon AWS Secret Key.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the topic.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
subject(String subject)
The subject which is used if the message header 'CamelAwsSnsSubject' is not present.default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder
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 AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder amazonSNSClient(com.amazonaws.services.sns.AmazonSNS amazonSNSClient)
To use the AmazonSNS as the client. The option is a:com.amazonaws.services.sns.AmazonSNS
type. Group: producer
-
amazonSQSClient
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder amazonSQSClient(com.amazonaws.services.sqs.AmazonSQS amazonSQSClient)
An SQS Client to use as bridge between SNS and SQS. The option is a:com.amazonaws.services.sqs.AmazonSQS
type. Group: producer
-
autoCreateTopic
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder autoCreateTopic(boolean autoCreateTopic)
Setting the autocreation of the topic. The option is a:boolean
type. Default: true Group: producer
-
autoDiscoverClient
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder autoDiscoverClient(boolean autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a:boolean
type. Default: true Group: common
-
configuration
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder configuration(org.apache.camel.component.aws.sns.SnsConfiguration configuration)
The component configuration. The option is a:org.apache.camel.component.aws.sns.SnsConfiguration
type. Group: producer
-
kmsMasterKeyId
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder 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 AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder 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 AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder messageStructure(String messageStructure)
The message structure to use such as json. The option is a:java.lang.String
type. Group: producer
-
policy
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder policy(String policy)
The policy for this queue. The option is a:java.lang.String
type. Group: producer
-
proxyHost
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder 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 AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder 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 AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder proxyProtocol(com.amazonaws.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SNS client. The option is a:com.amazonaws.Protocol
type. Default: HTTPS Group: producer
-
queueUrl
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder queueUrl(String queueUrl)
The queueUrl to subscribe to. The option is a:java.lang.String
type. Group: producer
-
region
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder region(String 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(). The option is a:java.lang.String
type. Group: producer
-
serverSideEncryptionEnabled
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder 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 AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder 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 AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder 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
-
autowiredEnabled
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder autowiredEnabled(boolean autowiredEnabled)
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. The option is a:boolean
type. Default: true Group: advanced
-
accessKey
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder accessKey(String accessKey)
Amazon AWS Access Key. The option is a:java.lang.String
type. Group: security
-
secretKey
default AwsSnsComponentBuilderFactory.AwsSnsComponentBuilder secretKey(String secretKey)
Amazon AWS Secret Key. The option is a:java.lang.String
type. Group: security
-
-