7.3. 组件选项
AWS Simple Queue Service (SQS)组件支持 43 选项,这些选项如下。
| Name | 描述 | 默认 | 类型 |
|---|---|---|---|
| amazonAWSHost (common) | Amazon AWS 云的主机名。 | amazonaws.com | 字符串 |
| amazonSQSClient (common) | Autowired To 使用 AmazonSQS 作为客户端。 | SqsClient | |
| autoCreateQueue (common) | 设置队列的自动。 | false | 布尔值 |
| 配置 (通用) | AWS SQS 默认配置。 | Sqs2Configuration | |
| overrideEndpoint (common) | 设置用于隐藏端点的需求。这个选项需要与 uriEndpointOverride 选项结合使用。 | false | 布尔值 |
| 协议 (通用) | 用于与 SQS 通信的底层协议。 | https | 字符串 |
| proxyprotocol (通用) | 在实例化 SQS 客户端时定义代理协议。 枚举值:
| HTTPS | 协议 |
| queueOwnerAWSAccountId (common) | 当您需要将队列所有者与不同的帐户所有者连接时,指定队列所有者 aws 帐户 id。 | 字符串 | |
| 区域 (通用) | SQS 客户端在其中需要工作的区域。使用此参数时,该配置期望区域(例如 ap-east-1)的小写名称需要使用名称 Region.EU_WEST_1.id ()。 | 字符串 | |
| trustAllCertificates (common) | 如果要信任覆盖端点的所有证书。 | false | 布尔值 |
| uriEndpointOverride (common) | 设置覆盖 uri 端点。这个选项必须与 overrideEndpoint 选项结合使用。 | 字符串 | |
| 使用DefaultCredentialsProvider (常见) | 设置 SQS 客户端是否应该需要在 AWS infra 实例中加载凭证,或者预期传递静态凭证。 | false | 布尔值 |
| attributeNames (consumer) | 要在使用时接收的属性名称列表。可以使用逗号分隔多个名称。 | 字符串 | |
| bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由 Error Handler,这意味着使用者试图获取传入消息或类似信息时出现任何异常,现在将作为一个消息进行处理,并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.Exception 处理程序处理异常,该处理程序将记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
| 并发关系 (消费者) | 允许您使用多个线程轮询 sqs 队列来增加吞吐量。 | 1 | int |
| defaultVisibilityTimeout (consumer) | 默认可见性超时(以秒为单位)。 | 整数 | |
| deleteAfterRead (consumer) | 读取后,从 SQS 删除消息。 | true | 布尔值 |
| deleteIfFiltered (consumer) | 如果交换具有键 Sqs2Constants#SQS_DELETE_FILTERED (CamelAwsSqsDeleteFiltered)属性,则是否将 DeleteMessage 发送到 SQS 队列。 | true | 布尔值 |
| 扩展 MessageVisibility (consumer) | 如果启用,则调度的后台任务将保持扩展 SQS 上的消息可见性。如果处理消息所需的时间较长,则需要这样做。如果设置为 true defaultVisibilityTimeout。 | false | 布尔值 |
| kmsDataKeyReusePeriodSeconds (consumer) | Amazon SQS 可以重复使用数据密钥在再次调用 AWS KMS 前加密或解密消息的时间长度(以秒为单位)。整数,代表 60 秒(1 分钟)和 86,400 秒(24 小时)。默认:300 (5 分钟)。 | 整数 | |
| kmsMasterKeyId (consumer) | Amazon SQS 或自定义 CMK 的 AWS 管理的客户 master 密钥(CMK)的 ID。 | 字符串 | |
| messageAttributeNames (consumer) | 要在使用时接收的消息属性名称列表。可以使用逗号分隔多个名称。 | 字符串 | |
| serverSideEncryptionEnabled (consumer) | 定义是否启用服务器侧加密,或者在队列中定义。 | false | 布尔值 |
| visibilityTimeout (consumer) | 在由 ReceiveMessage 请求检索后,接收消息的持续时间(以秒为单位)会在 com.amazonaws.services.sqsqs.SetQueueAttributesRequest 中检索后才会从后续检索请求中隐藏。只有与 defaultVisibilityTimeout 不同时,这才有意义。它永久更改队列 visibility timeout 属性。 | 整数 | |
| waitTimeSeconds (consumer) | ReceiveMessage 操作调用将等待队列中的消息包含在响应中时(0 到 20)的持续时间(0 到 20)。 | 整数 | |
| batchSeparator (producer) | 在传递 String 以发送批处理消息操作时设置分隔符。 | , | 字符串 |
| delaySeconds (重现) | 延迟为秒数的发送消息。 | 整数 | |
| lazyStartProducer (producer) | 制作者是否应启动 lazy (在第一条消息中)。通过开始 lazy,您可以使用此方法来允许 CamelContext 和路由在制作者无法启动时启动失败,并导致路由无法启动。通过将此启动推迟为 lazy,则启动失败可以通过 Camel 的路由错误处理程序在路由消息期间处理。请注意,当处理第一条消息时,创建和启动制作者可能需要花费一些时间,延长处理总处理时间。 | false | 布尔值 |
| messageDeduplicationIdStrategy (producer) | 只适用于 FIFO 队列。在消息上设置 messageDeduplicationId 的策略。可以是以下选项之一: useExchangeId,使用ContentBasedDeduplication。对于 useContentBasedDeduplication 选项,消息中不会设置 messageDeduplicationId。 枚举值:
| useExchangeId | 字符串 |
| messageGroupIdStrategy (producer) | 只适用于 FIFO 队列。用于在消息上设置 messageGroupId 的策略。可以是以下选项之一: useConstant, useExchangeId, usePropertyValue。对于 usePropertyValue 选项,将使用属性 CamelAwsMessageGroupId 的值。 枚举值:
| 字符串 | |
| 操作 (生成器) | 当用户不希望只发送消息时要执行的操作。 枚举值:
| Sqs2Operations | |
| autowiredEnabled (advanced) | 是否启用了 autowiring。这用于自动自动选项( 选项必须标记为自动线),方法是在 registry 中查找是否有匹配的类型实例,然后再在组件上配置。这可用于自动配置 JDBC 数据源、JMS 连接工厂、AWS 客户端等。 | true | 布尔值 |
| delayQueue (高级) | 定义是否要将 delaySeconds 选项应用到队列或单个消息。 | false | 布尔值 |
| queueUrl (advanced) | 明确定义 queueUrl。所有其他影响 queueUrl 的参数将被忽略。出于测试目的,可使用此参数连接到 SQS 的模拟实施。 | 字符串 | |
| proxyHost (proxy) | 在实例化 SQS 客户端时,要定义代理主机。 | 字符串 | |
| proxyPort (proxy) | 在实例化 SQS 客户端时定义代理端口。 | 整数 | |
| maximumMessageSize (queue) | maximumMessageSize (以字节为单位)可以为此队列包含 SQS 消息。 | 整数 | |
| messageRetentionPeriod (queue) | 此队列的 SQS 将保留消息RetentionPeriod (以秒为单位)。 | 整数 | |
| policy (queue) | 此队列的策略。它默认可从 classpath 加载,但您可以使用 classpath:、file: 或 http: 来从不同系统加载资源。 | 字符串 | |
| receiveMessageWaitTimeSeconds (queue) | 如果您没有在请求中指定 WaitTimeSeconds,则 queue 属性 ReceiveMessageWaitTimeSeconds 用于确定等待的时长。 | 整数 | |
| redrivePolicy (queue) | 指定向 DeadLetter 队列发送消息的策略。请参阅 Amazon 文档的详细信息。 | 字符串 | |
| 访问密钥 (安全性) | Amazon AWS 访问密钥。 | 字符串 | |
| secretKey (security) | Amazon AWS 机密密钥。 | 字符串 |