32.2. URI 选项
AWS S3 Storage Service 组件支持 5 个选项,如下所列。
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
configuration (advanced) | AWS S3 默认配置 | S3Configuration | |
accessKey (common) | Amazon AWS 访问密钥 | 字符串 | |
secretKey (common) | Amazon AWS Secret 密钥 | 字符串 | |
region (common) | bucket 所在的区域。这个选项在 com.amazonaws.services.s3.model.CreateBucketRequest 中使用。 | 字符串 | |
resolveProperty Placeholders (advanced) | 启动时组件是否应解析自身上的属性占位符。只有属于 String 类型的属性才能使用属性占位符。 | true | 布尔值 |
AWS S3 Storage Service 端点使用 URI 语法进行配置:
aws-s3:bucketNameOrArn
使用以下路径和查询参数:
32.2.1. 路径参数(1 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
bucketNameOrArn | 所需的 Bucket 名称或 ARN | 字符串 |
32.2.2. 查询参数(50 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
amazonS3Client (common) | 对链接中的 com.amazonaws.services.sqs.AmazonS3 的引用:https://camel.apache.org/registry.htmlRegistry。 | AmazonS3 | |
pathStyleAccess (common) | S3 客户端是否应该使用路径风格的访问 | false | 布尔值 |
policy (common) | 此队列的策略在 com.amazonaws.services.s3.AmazonS3#setBucketPolicy() 方法中设置。 | 字符串 | |
proxyHost (common) | 在实例化 SQS 客户端时定义代理主机 | 字符串 | |
proxyPort (common) | 指定要在客户端定义中使用的代理端口。 | 整数 | |
region (common) | S3 客户端需要工作的区域 | 字符串 | |
useIAMCredentials (common) | 设置 S3 客户端是否应该预期在 EC2 实例上加载凭据,或者希望传递静态凭据。 | false | 布尔值 |
encryptionMaterials (common) | 在 Symmetric/Asymmetric 客户端使用时要使用的加密资料 | EncryptionMaterials | |
useEncryption (common) | 定义是否使用加密 | false | 布尔值 |
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
deleteAfterRead (consumer) | 在检索后,从 S3 删除对象。只有在提交 Exchange 时,才会执行删除。如果进行回滚,则对象不会被删除。如果此选项为 false,则同一对象将被通过并再次在轮询上检索。因此,您需要使用路由中的 Idempotent Consumer EIP 来过滤重复项。您可以使用 S3Constants#BUCKET_NAME 和 S3Constants="KEY 标头进行过滤,或者仅使用 S3Constants#KEY 标头。 | true | 布尔值 |
fileName (consumer) | 使用给定文件名从存储桶获取对象 | 字符串 | |
includeBody (consumer) | 如果为 true,则交换正文将设置为文件内容的流。如果为 false,则标头将使用 S3 对象元数据设置,但正文为 null。这个选项与 autocloseBody 选项密切相关。如果将 includeBody 设为 true,autocloseBody 设为 false,它将是关闭 S3Object 流的调用者。将 autocloseBody 设置为 true,将自动关闭 S3Object 流。 | true | 布尔值 |
maxConnections (consumer) | 在 S3 客户端配置中设置 maxConnections 参数 | 60 | int |
maxMessagesPerPoll (consumer) | 获取最大消息数,作为每次轮询轮询的限制。默认为没有限制,但使用 0 或负数将其禁用为无限。 | 10 | int |
prefix (consumer) | com.amazonaws.services.s3.model.ListObjectsRequest 中使用的前缀,仅用于消费我们感兴趣的对象。 | 字符串 | |
sendEmptyMessageWhenIdle (consumer) | 如果轮询使用者没有轮询任何文件,您可以启用此选项来发送空消息(无正文)。 | false | 布尔值 |
autocloseBody (consumer) | 如果此选项为 true,并且 includeBody 为 true,则在交换完成时调用 S3Object.close ()方法。此选项与 includeBody 选项密切相关。如果将 includeBody 设为 true,autocloseBody 设为 false,它将是关闭 S3Object 流的调用者。将 autocloseBody 设置为 true,将自动关闭 S3Object 流。 | true | 布尔值 |
exceptionHandler (consumer) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。 | ExceptionHandler | |
exchangePattern (consumer) | 在消费者创建交换时设置交换模式。 | ExchangePattern | |
pollStrategy (consumer) | 可插拔 org.apache.camel.PollingConsumerPollingStrategy 允许您提供自定义实施来控制在轮询操作期间通常会发生错误处理,然后再创建交换并在 Camel 中路由。 | PollingConsumerPoll Strategy | |
deleteAfterWrite (producer) | 在 S3 文件上传后删除文件对象 | false | 布尔值 |
multiPartUpload (producer) | 如果为 true,则 camel 将上传带有多部分格式的文件,则部分大小由 partSize 选项决定 | false | 布尔值 |
operation (producer) | 当用户不希望只进行上传时,要执行的操作 | S3Operations | |
partSize (producer) | 设置多部分上传中使用的 partSize,默认大小为 25M。 | 26214400 | long |
serverSideEncryption (producer) | 在使用 AWS 管理的密钥加密对象时设置服务器端加密算法。例如,使用 AES256。 | 字符串 | |
storageClass (producer) | 在 com.amazonaws.services.s3.model.PutObjectRequest 请求中设置的存储类。 | 字符串 | |
awsKMSKeyId (producer) | 定义在启用 KMS 时要使用的 KMS 密钥 ID | 字符串 | |
useAwsKMS (producer) | 定义是否必须使用 KMS | false | 布尔值 |
同步 (advanced) | 设置是否应严格使用同步处理,或者 Camel 允许使用异步处理(如果受支持)。 | false | 布尔值 |
accelerateModeEnabled ( advanced) | 定义是否启用 Accelerate Mode 为 true 或 false | false | 布尔值 |
chunkedEncodingDisabled ( advanced) | 定义是否禁用了 Chunked Encoding 为 true 或 false | false | 布尔值 |
dualstackEnabled ( advanced) | 定义是否启用了 Dualstack 是否为 true 或 false | false | 布尔值 |
forceGlobalBucketAccess Enabled (高级) | 定义是否启用 Force Global Bucket Access 为 true 或 false | false | 布尔值 |
payloadSigningEnabled ( advanced) | 定义是否启用了 Payload Signing 为 true 或 false | false | 布尔值 |
backoffErrorThreshold (scheduler) | 在 backoffMultipler 应该 kick-in 之前发生的后续错误轮询(因为某些错误)的数量。 | int | |
backoffIdleThreshold (scheduler) | 在 backoffMultipler 应该 kick-in 之前应该发生的后续空闲轮询数量。 | int | |
backoffMultiplier (scheduler) | 如果一行中有很多后续空闲/errors,则让调度的轮询消费者避退。然后,倍数是在下一次实际尝试再次发生前跳过的轮询数量。当使用这个选项时,还必须配置 backoffIdleThreshold 和/或 backoffErrorThreshold。 | int | |
delay (scheduler) | 下一次轮询前的时间(毫秒)。您还可以使用单位来指定时间值,如 60s (60 秒)、5m30s (5 分钟和 30 秒)和 1h (1 小时)。 | 500 | long |
greedy (scheduler) | 如果启用了 greedy,如果上一个运行轮询 1 或更多消息,则 ScheduledPollConsumer 将立即运行。 | false | 布尔值 |
initialDelay (scheduler) | 第一次轮询开始前的毫秒。您还可以使用单位来指定时间值,如 60s (60 秒)、5m30s (5 分钟和 30 秒)和 1h (1 小时)。 | 1000 | long |
runLoggingLevel (scheduler) | 消费者在轮询时记录 start/complete log 行。这个选项允许您为其配置日志级别。 | TRACE | LoggingLevel |
scheduledExecutorService (scheduler) | 允许配置用于消费者的自定义/共享线程池。默认情况下,每个使用者都有自己的单线程线程池。 | ScheduledExecutor Service | |
scheduler (scheduler) | 使用 camel-spring 或 camel-quartz2 组件的 cron 调度程序 | none | ScheduledPollConsumer Scheduler |
schedulerProperties (scheduler) | 在使用自定义调度程序或任何基于 Spring 的调度程序时配置附加属性。 | Map | |
startScheduler (scheduler) | 调度程序是否应自动启动。 | true | 布尔值 |
timeUnit (scheduler) | initialDelay 和 delay 选项的时间单位。 | MILLISECONDS | TimeUnit |
useFixedDelay (scheduler) | 控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。 | true | 布尔值 |
accessKey (security) | Amazon AWS 访问密钥 | 字符串 | |
secretKey (security) | Amazon AWS Secret 密钥 | 字符串 |