Package org.apache.camel.component.aws2.sns

Class Sns2Configuration

java.lang.Object
org.apache.camel.component.aws2.sns.Sns2Configuration
All Implemented Interfaces:
Cloneable
@UriParams public class Sns2Configuration extends Object implements Cloneable

  • Constructor Details

    • Sns2Configuration

      public Sns2Configuration()

  • Method Details

    • getSubject

      public String getSubject()

    • setSubject

      public void setSubject(String subject)
      The subject which is used if the message header 'CamelAwsSnsSubject' is not present.

    • getTopicArn

      public String getTopicArn()

    • setTopicArn

      public void setTopicArn(String topicArn)
      The Amazon Resource Name (ARN) assigned to the created topic.

    • getAccessKey

      public String getAccessKey()

    • setAccessKey

      public void setAccessKey(String accessKey)
      Amazon AWS Access Key

    • getSecretKey

      public String getSecretKey()

    • setSecretKey

      public void setSecretKey(String secretKey)
      Amazon AWS Secret Key

    • getAmazonSNSClient

      public software.amazon.awssdk.services.sns.SnsClient getAmazonSNSClient()

    • setAmazonSNSClient

      public void setAmazonSNSClient(software.amazon.awssdk.services.sns.SnsClient amazonSNSClient)
      To use the AmazonSNS as the client

    • getTopicName

      public String getTopicName()

    • setTopicName

      public void setTopicName(String topicName)
      The name of the topic

    • getPolicy

      public String getPolicy()

    • setPolicy

      public void setPolicy(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.

    • getMessageStructure

      public String getMessageStructure()

    • setMessageStructure

      public void setMessageStructure(String messageStructure)
      The message structure to use such as json

    • getProxyProtocol

      public software.amazon.awssdk.core.Protocol getProxyProtocol()

    • setProxyProtocol

      public void setProxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the SNS client

    • getProxyHost

      public String getProxyHost()

    • setProxyHost

      public void setProxyHost(String proxyHost)
      To define a proxy host when instantiating the SNS client

    • getProxyPort

      public Integer getProxyPort()

    • setProxyPort

      public void setProxyPort(Integer proxyPort)
      To define a proxy port when instantiating the SNS client

    • getRegion

      public String getRegion()

    • setRegion

      public void setRegion(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()

    • getQueueUrl

      public String getQueueUrl()

    • setQueueUrl

      public void setQueueUrl(String queueUrl)
      The queueUrl to subscribe to

    • isSubscribeSNStoSQS

      public boolean isSubscribeSNStoSQS()

    • setSubscribeSNStoSQS

      public void setSubscribeSNStoSQS(boolean subscribeSNStoSQS)
      Define if the subscription between SNS Topic and SQS must be done or not

    • getKmsMasterKeyId

      public String getKmsMasterKeyId()

    • setKmsMasterKeyId

      public void setKmsMasterKeyId(String kmsMasterKeyId)
      The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.

    • isServerSideEncryptionEnabled

      public boolean isServerSideEncryptionEnabled()

    • setServerSideEncryptionEnabled

      public void setServerSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
      Define if Server Side Encryption is enabled or not on the topic

    • isAutoCreateTopic

      public boolean isAutoCreateTopic()

    • setAutoCreateTopic

      public void setAutoCreateTopic(boolean autoCreateTopic)
      Setting the autocreation of the topic

    • isTrustAllCertificates

      public boolean isTrustAllCertificates()

    • setTrustAllCertificates

      public void setTrustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint

    • isUseDefaultCredentialsProvider

      public boolean isUseDefaultCredentialsProvider()

    • setUseDefaultCredentialsProvider

      public void setUseDefaultCredentialsProvider(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.

    • setUseProfileCredentialsProvider

      public void setUseProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the SNS client should expect to load credentials through a profile credentials provider.

    • isUseProfileCredentialsProvider

      public boolean isUseProfileCredentialsProvider()

    • getProfileCredentialsName

      public String getProfileCredentialsName()

    • setProfileCredentialsName

      public void setProfileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider this parameter will set the profile name

    • setMessageGroupIdStrategy

      public void setMessageGroupIdStrategy(String strategy)
      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.

    • setMessageGroupIdStrategy

      public void setMessageGroupIdStrategy(MessageGroupIdStrategy messageGroupIdStrategy)

    • getMessageGroupIdStrategy

      public MessageGroupIdStrategy getMessageGroupIdStrategy()

    • getMessageDeduplicationIdStrategy

      public MessageDeduplicationIdStrategy getMessageDeduplicationIdStrategy()

    • setMessageDeduplicationIdStrategy

      public void setMessageDeduplicationIdStrategy(String strategy)
      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.

    • setMessageDeduplicationIdStrategy

      public void setMessageDeduplicationIdStrategy(MessageDeduplicationIdStrategy messageDeduplicationIdStrategy)

    • isOverrideEndpoint

      public boolean isOverrideEndpoint()

    • setOverrideEndpoint

      public void setOverrideEndpoint(boolean overrideEndpoint)
      Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option

    • getUriEndpointOverride

      public String getUriEndpointOverride()

    • setUriEndpointOverride

      public void setUriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option

    • copy

      public Sns2Configuration copy()