9.5. 端点选项

bucketNameOrArn (common)

所需的 Bucket 名称或 ARN。

字符串

amazonS3Client (common)

对 registry 中的 com.amazonaws.services.s3.AmazonS3 的 Autowired Reference。

S3Client

amazonS3Presigner (common)

Autowired 一个用于请求的 S3 Presigner，主要在 createDownloadLink 操作中使用。

S3Presigner

autoCreateBucket (common)

设置 S3 存储桶自动创建的 bucketName。如果启用了 moveAfterRead 选项，则也会应用它，如果尚未存在 moveAfterRead 选项，它将创建 destinationBucket。

false

布尔值

overrideEndpoint (common)

设置覆盖端点的需要。这个选项需要与 uriEndpointOverride 选项结合使用。

false

布尔值

pojoRequest (common)

如果您想要将 POJO 请求用作正文。

false

布尔值

policy (common)

此队列的策略在 com.amazonaws.services.s3.AmazonS3#setBucketPolicy() 方法中设置。

字符串

proxyHost (common)

在实例化 SQS 客户端时定义代理主机。

字符串

proxyPort (common)

指定要在客户端定义中使用的代理端口。

整数

proxyProtocol (common)

在实例化 S3 客户端时定义代理协议。

Enum 值：

HTTPS

协议

region (common)

S3 客户端需要工作的区域。使用此参数时，配置将预期区域（如 ap-east-1）的小写名称，您需要使用名称 Region.EU_WEST_1.id()。

字符串

trustAllCertificates (common)

如果要在覆盖端点时信任所有证书。

false

布尔值

uriEndpointOverride (common)

设置覆盖 uri 端点。这个选项需要与 overrideEndpoint 选项结合使用。

字符串

useDefaultCredentialsProvider (common)

设置 S3 客户端是否应该希望通过默认凭据提供程序加载凭据，或者希望传递静态凭据。

false

布尔值

customerAlgorithm (common (advanced))

定义在启用了 CustomerKey 时要使用的客户算法。

字符串

customerKeyId (common (advanced))

定义在启用 CustomerKey 时要使用的 Customer key 的 id。

字符串

customerKeyMD5 (common (advanced))

定义在启用 CustomerKey 时要使用的客户密钥的 MD5。

字符串

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由错误处理程序，这意味着当消费者试图选择传入消息或类似信息时发生异常，现在将作为消息处理并由路由 Error Handler 处理。默认情况下，使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况，该处理程序将被记录在 WARN 或 ERROR 级别，并忽略。

false

布尔值

deleteAfterRead (consumer)

在检索后，从 S3 删除对象。只有在提交 Exchange 时，才会执行删除。如果进行回滚，则对象不会被删除。如果此选项为 false，则同一对象将被通过并再次在轮询上检索。因此，您需要使用路由中的 Idempotent Consumer EIP 来过滤重复项。您可以使用 AWS2S3Constants#BUCKET_NAME 和 AWS2S3Constants#KEY 标头过滤，或者只过滤 AWS2S3Constants#KEY 标头。

true

布尔值

delimiter (consumer)

com.amazonaws.services.s3.model.ListObjectsRequest 中使用的分隔符仅消耗我们感兴趣的对象。

字符串

destinationBucket (consumer)

定义当 moveAfterRead 设置为 true 时必须移动对象的目标存储桶。

字符串

destinationBucketPrefix (consumer)

定义在必须移动对象并将 moveAfterRead 设置为 true 时使用的目标存储桶前缀。

字符串

destinationBucketSuffix (consumer)

定义在必须移动对象并将 moveAfterRead 设置为 true 时使用的目标存储桶后缀。

字符串

doneFileName (consumer)

如果提供，Camel 仅在文件存在时使用文件。

字符串

fileName (consumer)

要从具有给定文件名的存储桶获取对象。

字符串

ignoreBody (consumer)

如果为 true，则 S3 对象正文将完全忽略，如果设为 false，则 S3 对象将放入正文中。把它设置为 true，将覆盖 includeBody 选项定义的任何行为。

false

布尔值

includeBody (consumer)

如果为 true，则 S3Object Exchange 将被使用并放入正文和关闭中。如果为 false，S3Object 流将原始放在正文中，标头将使用 S3 对象元数据设置。这个选项与 autocloseBody 选项密切相关。如果将 includeBody 设为 true，因为 S3Object 流将被消耗，然后也会关闭它，而在 includeBody false 时，它将是关闭 S3Object 流的调用者。但是，当 includeBody 为 false 时，将 autocloseBody 设置为 true，它将在交换完成时自动关闭 S3Object 流。

true

布尔值

includeFolders (consumer)

如果为 true，将消费的文件夹/目录。如果是 false，则忽略它们，且不会为那些交换创建。

true

布尔值

maxConnections (consumer)

在 S3 客户端配置中设置 maxConnections 参数。

60

int

maxMessagesPerPoll (consumer)

获取最大消息数，作为每次轮询轮询的限制。获取最大消息数，作为每次轮询轮询的限制。默认值为 10。使用 0 或负数设置为无限。

10

int

moveAfterRead (consumer)

在检索后，将对象从 S3 存储桶移到不同的存储桶。要完成操作，必须设置 destinationBucket 选项。仅当 Exchange 提交时，才会执行复制存储桶操作。如果进行回滚，则对象不会被移动。

false

布尔值

prefix (consumer)

com.amazonaws.services.s3.model.ListObjectsRequest 中使用的前缀，仅用于消费我们感兴趣的对象。

字符串

sendEmptyMessageWhenIdle (consumer)

如果轮询使用者没有轮询任何文件，您可以启用此选项来发送空消息（无正文）。

false

布尔值

autocloseBody (consumer (advanced))

如果此选项为 true，且 includeBody 为 false，则在交换完成时调用 S3Object.close() 方法。此选项与 includeBody 选项密切相关。如果将 includeBody 设为 false，autocloseBody 设为 false，它将是关闭 S3Object 流的调用者。将 autocloseBody 设置为 true，将自动关闭 S3Object 流。

true

布尔值

exceptionHandler (consumer (advanced))

要让使用者使用自定义例外处理程序：请注意，如果启用了 bridgeErrorHandler 选项，则此选项不使用。默认情况下，消费者将处理异常，其记录在 WARN 或 ERROR 级别中，并忽略。

ExceptionHandler

exchangePattern (consumer (advanced))

在消费者创建交换时设置交换模式。

Enum 值：

ExchangePattern

pollStrategy (consumer (advanced))

可插拔 org.apache.camel.PollingConsumerPollingStrategy 允许您提供自定义实施来控制在轮询操作期间通常会发生错误处理，然后再创建交换并在 Camel 中路由。

PollingConsumerPollStrategy

batchMessageNumber (producer)

在流传输上传模式中制作批处理的消息数量。

10

int

batchSize (producer)

流上传模式的批处理大小（以字节为单位）。

1000000

int

deleteAfterWrite (producer)

在 S3 文件上传后删除文件对象。

false

布尔值

KeyName (producer)

通过端点参数在存储桶中设置元素的密钥名称。

字符串

lazyStartProducer (producer)

生成者是否应懒惰启动 （在第一个消息中）。通过懒惰启动，您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动，并导致路由启动失败。通过懒惰启动，启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意，在处理第一个消息时，创建并启动生成者可能需要稍等时间，并延长处理的总处理时间。

false

布尔值

multiPartUpload (producer)

如果为 true，则 camel 将上传带有多部分格式的文件，由 partSize 选项决定部分大小。

false

布尔值

namingStrategy (producer)

在流上传模式中使用的命名策略。

Enum 值：

progressive

AWSS3NamingStrategyEnum

operation (producer)

当用户不希望只进行上传时，要执行的操作。

Enum 值：

AWS2S3Operations

partSize (producer)

设置多部分上传中使用的 partSize，默认大小为 25M。

26214400

long

restartingPolicy (producer)

在流上传模式中使用的重启策略。

Enum 值：

override

AWSS3RestartingPolicyEnum

storageClass (producer)

在 com.amazonaws.services.s3.model.PutObjectRequest 请求中设置的存储类。

字符串

streamingUploadMode (producer)

当流模式为 true 时，上传到存储桶将以流传输方式进行。

false

布尔值

streamingUploadTimeout (producer)

在流上传模式为 true 时，此选项会将超时设置为完成上传。

long

awsKMSKeyId (producer (advanced))

定义在启用 KMS 时要使用的 KMS 密钥 ID。

字符串

useAwsKMS (producer (advanced))

定义是否必须使用 KMS。

false

布尔值

useCustomerKey (producer (advanced))

定义是否需要使用客户密钥。

false

布尔值

backoffErrorThreshold (scheduler)

在 backoffMultipler 应该 kick-in 之前发生的后续错误轮询（因为某些错误）的数量。

int

backoffIdleThreshold (scheduler)

在 backoffMultipler 应该 kick-in 之前应该发生的后续空闲轮询数量。

int

backoffMultiplier (scheduler)

如果一行中有很多后续空闲/errors，则让调度的轮询消费者避退。然后，倍数是在下一次实际尝试再次发生前跳过的轮询数量。当使用这个选项时，还必须配置 backoffIdleThreshold 和/或 backoffErrorThreshold。

int

delay (scheduler)

下一次轮询前的时间（毫秒）。

500

long

greedy (scheduler)

如果启用了 greedy，如果上一个运行轮询 1 或更多消息，则 ScheduledPollConsumer 将立即运行。

false

布尔值

initialDelay (scheduler)

第一次轮询开始前的毫秒。

1000

long

repeatCount (scheduler)

指定触发的最大数量。因此，如果您将其设置为 1，调度程序将只触发一次。如果您将其设置为 5，它将只触发五次。值为零或负数表示会永久触发。

0

long

runLoggingLevel (scheduler)

消费者在轮询时记录 start/complete log 行。这个选项允许您为其配置日志级别。

Enum 值：

TRACE

LoggingLevel

scheduledExecutorService (scheduler)

允许配置用于消费者的自定义/共享线程池。默认情况下，每个使用者都有自己的单线程线程池。

ScheduledExecutorService

scheduler (scheduler)

要使用 camel-spring 或 camel-quartz 组件的 cron 调度程序。使用值 spring 或 quartz 用于内置在调度程序中。

none

对象

schedulerProperties (scheduler)

在使用自定义调度程序或任何基于 Spring 的调度程序时配置附加属性。

Map

startScheduler (scheduler)

调度程序是否应自动启动。

true

布尔值

timeUnit (scheduler)

initialDelay 和 delay 选项的时间单位。

Enum 值：

MILLISECONDS

TimeUnit

useFixedDelay (scheduler)

控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。

true

布尔值

accessKey (security)

Amazon AWS 访问密钥.

字符串

secretKey (security)

Amazon AWS Secret 密钥。

字符串