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