Package org.apache.camel.builder.endpoint.dsl

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 Details

    • advanced

      default Sns2EndpointBuilderFactory.AdvancedSns2EndpointBuilder advanced()

    • autoCreateTopic

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder autoCreateTopic(boolean autoCreateTopic)
      Setting the auto-creation of the topic. The option is a: boolean type. Default: false Group: producer
      Parameters:
      autoCreateTopic - the value to set
      Returns:
      the dsl builder

    • autoCreateTopic

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder autoCreateTopic(String autoCreateTopic)
      Setting the auto-creation of the topic. The option will be converted to a boolean 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: org.apache.camel.spi.HeaderFilterStrategy 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 org.apache.camel.spi.HeaderFilterStrategy 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: java.lang.String 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. It 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: java.lang.String 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. It can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsSnsMessageGroupId will be used. The option is a: java.lang.String 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: java.lang.String type. Group: producer
      Parameters:
      messageStructure - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. The option is a: boolean 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 overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. The option will be converted to a boolean 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. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.lang.String type. Group: producer
      Parameters:
      policy - the value to set
      Returns:
      the dsl builder

    • queueArn

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder queueArn(String queueArn)
      The ARN endpoint to subscribe to. The option is a: java.lang.String type. Group: producer
      Parameters:
      queueArn - the value to set
      Returns:
      the dsl builder

    • region

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder region(String region)
      The region in which the 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
      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: boolean 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 boolean 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: java.lang.String 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: boolean 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 boolean type. Default: false Group: producer
      Parameters:
      subscribeSNStoSQS - 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: java.lang.String type. Group: producer
      Parameters:
      uriEndpointOverride - 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: java.lang.String type. Group: proxy
      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: java.lang.Integer type. Group: proxy
      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 java.lang.Integer type. Group: proxy
      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: software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: proxy
      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 software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • accessKey

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder profileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider, this parameter will set the profile name. The option is a: java.lang.String type. Group: security
      Parameters:
      profileCredentialsName - the value to set
      Returns:
      the dsl builder

    • secretKey

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder

    • sessionToken

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder sessionToken(String sessionToken)
      Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a: java.lang.String type. Group: security
      Parameters:
      sessionToken - 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: boolean type. Default: false Group: security
      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 boolean type. Default: false Group: security
      Parameters:
      trustAllCertificates - 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: boolean type. Default: false Group: security
      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 boolean type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the SNS client should expect to load credentials through a profile credentials provider. The option is a: boolean type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider)
      Set whether the SNS client should expect to load credentials through a profile credentials provider. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the SNS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SNS. The option is a: boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default Sns2EndpointBuilderFactory.Sns2EndpointBuilder useSessionCredentials(String useSessionCredentials)
      Set whether the SNS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SNS. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder