Interface Sns2EndpointBuilderFactory.Sns2EndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- Sns2EndpointBuilderFactory
public static interface Sns2EndpointBuilderFactory.Sns2EndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the AWS Simple Notification System (SNS) component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
accessKey(String accessKey)
Amazon AWS Access Key.default Sns2EndpointBuilderFactory.AdvancedSns2EndpointBuilder
advanced()
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
amazonSNSClient(String amazonSNSClient)
To use the AmazonSNS as the client.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
amazonSNSClient(software.amazon.awssdk.services.sns.SnsClient amazonSNSClient)
To use the AmazonSNS as the client.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
autoCreateTopic(boolean autoCreateTopic)
Setting the autocreation of the topic.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
autoCreateTopic(String autoCreateTopic)
Setting the autocreation of the topic.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
kmsMasterKeyId(String kmsMasterKeyId)
The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
messageDeduplicationIdStrategy(String messageDeduplicationIdStrategy)
Only for FIFO Topic.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
messageGroupIdStrategy(String messageGroupIdStrategy)
Only for FIFO Topic.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
messageStructure(String messageStructure)
The message structure to use such as json.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
overrideEndpoint(boolean overrideEndpoint)
Set the need for overidding the endpoint.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
overrideEndpoint(String overrideEndpoint)
Set the need for overidding the endpoint.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
policy(String policy)
The policy for this topic.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
proxyHost(String proxyHost)
To define a proxy host when instantiating the SNS client.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SNS client.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
proxyPort(String proxyPort)
To define a proxy port when instantiating the SNS client.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the SNS client.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SNS client.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
queueUrl(String queueUrl)
The queueUrl to subscribe to.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
region(String region)
The region in which SNS client needs to work.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
secretKey(String secretKey)
Amazon AWS Secret Key.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the topic.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
serverSideEncryptionEnabled(String serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the topic.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
subject(String subject)
The subject which is used if the message header 'CamelAwsSnsSubject' is not present.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
subscribeSNStoSQS(boolean subscribeSNStoSQS)
Define if the subscription between SNS Topic and SQS must be done or not.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
subscribeSNStoSQS(String subscribeSNStoSQS)
Define if the subscription between SNS Topic and SQS must be done or not.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
trustAllCertificates(boolean trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
trustAllCertificates(String trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
uriEndpointOverride(String uriEndpointOverride)
Set the overriding uri endpoint.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
Set whether the SNS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in.default Sns2EndpointBuilderFactory.Sns2EndpointBuilder
useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
Set whether the SNS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in.
-
-
-
Method Detail
-
advanced
default Sns2EndpointBuilderFactory.AdvancedSns2EndpointBuilder advanced()
-
amazonSNSClient
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder amazonSNSClient(software.amazon.awssdk.services.sns.SnsClient amazonSNSClient)
To use the AmazonSNS as the client. The option is a: <code>software.amazon.awssdk.services.sns.SnsClient</code> type. Group: producer- Parameters:
amazonSNSClient
- the value to set- Returns:
- the dsl builder
-
amazonSNSClient
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder amazonSNSClient(String amazonSNSClient)
To use the AmazonSNS as the client. The option will be converted to a <code>software.amazon.awssdk.services.sns.SnsClient</code> type. Group: producer- Parameters:
amazonSNSClient
- the value to set- Returns:
- the dsl builder
-
autoCreateTopic
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder autoCreateTopic(boolean autoCreateTopic)
Setting the autocreation of the topic. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
autoCreateTopic
- the value to set- Returns:
- the dsl builder
-
autoCreateTopic
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder autoCreateTopic(String autoCreateTopic)
Setting the autocreation of the topic. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
autoCreateTopic
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: producer- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: producer- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
kmsMasterKeyId
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder kmsMasterKeyId(String kmsMasterKeyId)
The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
kmsMasterKeyId
- the value to set- Returns:
- the dsl builder
-
messageDeduplicationIdStrategy
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder messageDeduplicationIdStrategy(String messageDeduplicationIdStrategy)
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. The option is a: <code>java.lang.String</code> type. Default: useExchangeId Group: producer- Parameters:
messageDeduplicationIdStrategy
- the value to set- Returns:
- the dsl builder
-
messageGroupIdStrategy
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder messageGroupIdStrategy(String messageGroupIdStrategy)
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. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
messageGroupIdStrategy
- the value to set- Returns:
- the dsl builder
-
messageStructure
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder messageStructure(String messageStructure)
The message structure to use such as json. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
messageStructure
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder overrideEndpoint(boolean overrideEndpoint)
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder overrideEndpoint(String overrideEndpoint)
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
policy
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder policy(String policy)
The policy for this topic. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
policy
- the value to set- Returns:
- the dsl builder
-
proxyHost
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder proxyHost(String proxyHost)
To define a proxy host when instantiating the SNS client. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SNS client. The option is a: <code>java.lang.Integer</code> type. Group: producer- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyPort
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder proxyPort(String proxyPort)
To define a proxy port when instantiating the SNS client. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SNS client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: producer- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the SNS client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: producer- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
queueUrl
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder queueUrl(String queueUrl)
The queueUrl to subscribe to. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
queueUrl
- the value to set- Returns:
- the dsl builder
-
region
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder 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: <code>java.lang.String</code> type. Group: producer- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
serverSideEncryptionEnabled
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the topic. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
serverSideEncryptionEnabled
- the value to set- Returns:
- the dsl builder
-
serverSideEncryptionEnabled
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder serverSideEncryptionEnabled(String serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the topic. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
serverSideEncryptionEnabled
- the value to set- Returns:
- the dsl builder
-
subject
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder subject(String subject)
The subject which is used if the message header 'CamelAwsSnsSubject' is not present. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
subject
- the value to set- Returns:
- the dsl builder
-
subscribeSNStoSQS
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder subscribeSNStoSQS(boolean subscribeSNStoSQS)
Define if the subscription between SNS Topic and SQS must be done or not. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
subscribeSNStoSQS
- the value to set- Returns:
- the dsl builder
-
subscribeSNStoSQS
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder subscribeSNStoSQS(String subscribeSNStoSQS)
Define if the subscription between SNS Topic and SQS must be done or not. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
subscribeSNStoSQS
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder trustAllCertificates(boolean trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder trustAllCertificates(String trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder uriEndpointOverride(String uriEndpointOverride)
Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
uriEndpointOverride
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
Set whether the SNS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
Set whether the SNS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
accessKey
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder accessKey(String accessKey)
Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
secretKey
default Sns2EndpointBuilderFactory.Sns2EndpointBuilder secretKey(String secretKey)
Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
secretKey
- the value to set- Returns:
- the dsl builder
-
-