| {"component":{"kind":"component","name":"aws2-sns","title":"AWS Simple Notification System (SNS)","description":"Send messages to an AWS Simple Notification Topic using AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging,mobile","javaType":"org.apache.camel.component.aws2.sns.Sns2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-sns","version":"3.18.1","scheme":"aws2-sns","extendsScheme":"","syntax":"aws2-sns:topicNameOrArn","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelAwsSnsMessageId":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SNS message ID.","constantName":"org.apache.camel.component.aws2.sns.Sns2Constants#MESSAGE_ID"},"CamelAwsSnsSubject":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SNS message subject. If not set, the subject from the SnsConfiguration is used.","constantName":"org.apache.camel.component.aws2.sns.Sns2Constants#SUBJECT"},"CamelAwsSnsMessageStructure":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message structure to use such as json.","constantName":"org.apache.camel.component.aws2.sns.Sns2Constants#MESSAGE_STRUCTURE"}},"properties":{"topicNameOrArn":{"kind":"path","displayName":"Topic Name Or Arn","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Topic name or ARN"},"amazonSNSClient":{"kind":"parameter","displayName":"Amazon SNSClient","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sns.SnsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To use the AmazonSNS as the client"},"autoCreateTopic":{"kind":"parameter","displayName":"Auto Create Topic","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Setting the autocreation of the topic"},"headerFilterStrategy":{"kind":"parameter","displayName":"Header Filter Strategy","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to map headers to/from Camel."},"kmsMasterKeyId":{"kind":"parameter","displayName":"Kms Master Key Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK."},"messageDeduplicationIdStrategy":{"kind":"parameter","displayName":"Message Deduplication Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useExchangeId","useContentBasedDeduplication"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"useExchangeId","configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"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."},"messageGroupIdStrategy":{"kind":"parameter","displayName":"Message Group Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useConstant","useExchangeId","usePropertyValue"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"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."},"messageStructure":{"kind":"parameter","displayName":"Message Structure","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The message structure to use such as json"},"overrideEndpoint":{"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"policy":{"kind":"parameter","displayName":"Policy","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"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."},"proxyHost":{"kind":"parameter","displayName":"Proxy Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SNS client"},"proxyPort":{"kind":"parameter","displayName":"Proxy Port","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the SNS client"},"proxyProtocol":{"kind":"parameter","displayName":"Proxy Protocol","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the SNS client"},"queueUrl":{"kind":"parameter","displayName":"Queue Url","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The queueUrl to subscribe to"},"region":{"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"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()"},"serverSideEncryptionEnabled":{"kind":"parameter","displayName":"Server Side Encryption Enabled","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Define if Server Side Encryption is enabled or not on the topic"},"subject":{"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The subject which is used if the message header 'CamelAwsSnsSubject' is not present."},"subscribeSNStoSQS":{"kind":"parameter","displayName":"Subscribe SNSto SQS","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Define if the subscription between SNS Topic and SQS must be done or not"},"trustAllCertificates":{"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set whether the SNS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"accessKey":{"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"}}} |