SnsConfiguration (Camel :: AWS SNS 3.6.0 API)

java.lang.Object
- org.apache.camel.component.aws.sns.SnsConfiguration

All Implemented Interfaces:: Cloneable

@UriParams
public class SnsConfiguration
extends Object
implements Cloneable

Constructor Summary

Constructors
Constructor and Description

SnsConfiguration()

Constructors
Constructor and Description
`SnsConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SnsConfiguration`	`copy()`
`String`	`getAccessKey()`
`com.amazonaws.services.sns.AmazonSNS`	`getAmazonSNSClient()`
`com.amazonaws.services.sqs.AmazonSQS`	`getAmazonSQSClient()`
`String`	`getKmsMasterKeyId()`
`String`	`getMessageStructure()`
`String`	`getPolicy()`
`String`	`getProxyHost()`
`Integer`	`getProxyPort()`
`com.amazonaws.Protocol`	`getProxyProtocol()`
`String`	`getQueueUrl()`
`String`	`getRegion()`
`String`	`getSecretKey()`
`String`	`getSubject()`
`String`	`getTopicArn()`
`String`	`getTopicName()`
`boolean`	`isAutoCreateTopic()`
`boolean`	`isAutoDiscoverClient()`
`boolean`	`isServerSideEncryptionEnabled()`
`boolean`	`isSubscribeSNStoSQS()`
`void`	`setAccessKey(String accessKey)` Amazon AWS Access Key
`void`	`setAmazonSNSClient(com.amazonaws.services.sns.AmazonSNS amazonSNSClient)` To use the AmazonSNS as the client
`void`	`setAmazonSQSClient(com.amazonaws.services.sqs.AmazonSQS amazonSQSClient)` An SQS Client to use as bridge between SNS and SQS
`void`	`setAutoCreateTopic(boolean autoCreateTopic)` Setting the autocreation of the topic
`void`	`setAutoDiscoverClient(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.
`void`	`setKmsMasterKeyId(String kmsMasterKeyId)` The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.
`void`	`setMessageStructure(String messageStructure)` The message structure to use such as json
`void`	`setPolicy(String policy)` The policy for this queue
`void`	`setProxyHost(String proxyHost)` To define a proxy host when instantiating the SNS client
`void`	`setProxyPort(Integer proxyPort)` To define a proxy port when instantiating the SNS client
`void`	`setProxyProtocol(com.amazonaws.Protocol proxyProtocol)` To define a proxy protocol when instantiating the SNS client
`void`	`setQueueUrl(String queueUrl)` The queueUrl to subscribe to
`void`	`setRegion(String region)` The region in which SNS client needs to work.
`void`	`setSecretKey(String secretKey)` Amazon AWS Secret Key
`void`	`setServerSideEncryptionEnabled(boolean serverSideEncryptionEnabled)` Define if Server Side Encryption is enabled or not on the topic
`void`	`setSubject(String subject)` The subject which is used if the message header 'CamelAwsSnsSubject' is not present.
`void`	`setSubscribeSNStoSQS(boolean subscribeSNStoSQS)` Define if the subscription between SNS Topic and SQS must be done or not
`void`	`setTopicArn(String topicArn)` The Amazon Resource Name (ARN) assigned to the created topic.
`void`	`setTopicName(String topicName)` The name of the topic

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SnsConfiguration
```
public SnsConfiguration()
```

Method Detail

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 com.amazonaws.services.sns.AmazonSNS getAmazonSNSClient()

setAmazonSNSClient

public void setAmazonSNSClient(com.amazonaws.services.sns.AmazonSNS 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 queue

getMessageStructure
```
public String getMessageStructure()
```

setMessageStructure

public void setMessageStructure(String messageStructure)

The message structure to use such as json

getProxyProtocol

public com.amazonaws.Protocol getProxyProtocol()

setProxyProtocol
```
public void setProxyProtocol(com.amazonaws.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 capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name()

getAmazonSQSClient

public com.amazonaws.services.sqs.AmazonSQS getAmazonSQSClient()

setAmazonSQSClient

public void setAmazonSQSClient(com.amazonaws.services.sqs.AmazonSQS amazonSQSClient)

An SQS Client to use as bridge between SNS and SQS

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

isAutoDiscoverClient
```
public boolean isAutoDiscoverClient()
```

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

copy
```
public SnsConfiguration copy()
```

Class SnsConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SnsConfiguration

Method Detail

getSubject

setSubject

getTopicArn

setTopicArn

getAccessKey

setAccessKey

getSecretKey

setSecretKey

getAmazonSNSClient

setAmazonSNSClient

getTopicName

setTopicName

getPolicy

setPolicy

getMessageStructure

setMessageStructure

getProxyProtocol

setProxyProtocol

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getRegion

setRegion

getAmazonSQSClient

setAmazonSQSClient

getQueueUrl

setQueueUrl

isSubscribeSNStoSQS

setSubscribeSNStoSQS

getKmsMasterKeyId

setKmsMasterKeyId

isServerSideEncryptionEnabled

setServerSideEncryptionEnabled

isAutoCreateTopic

setAutoCreateTopic

isAutoDiscoverClient

setAutoDiscoverClient

copy