6.15. Spring Boot Auto-Configuration
当在 Spring Boot 中使用 aws2-s3 时,请确保使用以下 Maven 依赖项来支持自动配置:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-aws2-s3-starter</artifactId> </dependency>
组件支持 51 选项,如下所列。
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
camel.component.aws2-s3.access-key | Amazon AWS 访问密钥. | 字符串 | |
camel.component.aws2-s3.amazon-s3-client | 对 registry 中的 com.amazonaws.services.s3.AmazonS3 的引用。选项是一个 software.amazon.awssdk.services.s3.S3Client 类型。 | S3Client | |
camel.component.aws2-s3.amazon-s3-presigner | 用于 Request 的 S3 Presigner 主要在 createDownloadLink 操作中使用。选项是一个 software.amazon.awssdk.services.s3.presigner.S3Presigner 类型。 | S3Presigner | |
camel.component.aws2-s3.auto-create-bucket | 设置 S3 存储桶自动创建的 bucketName。如果启用了 moveAfterRead 选项,则也会应用它,如果尚未存在 moveAfterRead 选项,它将创建 destinationBucket。 | false | 布尔值 |
camel.component.aws2-s3.autoclose-body | 如果此选项为 true,且 includeBody 为 false,则在交换完成时调用 S3Object.close() 方法。此选项与 includeBody 选项密切相关。如果将 includeBody 设为 false,autocloseBody 设为 false,它将是关闭 S3Object 流的调用者。将 autocloseBody 设置为 true,将自动关闭 S3Object 流。 | true | 布尔值 |
camel.component.aws2-s3.autowired-enabled | 是否启用自动关闭。这用于自动关闭选项(选项必须标记为 autowired),方法是在 registry 中查找查找是否有单个匹配类型实例,然后在组件上配置。这可以用于自动配置 JDBC 数据源、JMS 连接工厂、AWS 客户端等。 | true | 布尔值 |
camel.component.aws2-s3.aws-k-m-s-key-id | 定义在启用 KMS 时要使用的 KMS 密钥 ID。 | 字符串 | |
camel.component.aws2-s3.batch-message-number | 在流传输上传模式中制作批处理的消息数量。 | 10 | 整数 |
camel.component.aws2-s3.batch-size | 流上传模式的批处理大小(以字节为单位)。 | 1000000 | 整数 |
camel.component.aws2-s3.bridge-error-handler | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
camel.component.aws2-s3.configuration | 组件配置。选项是 org.apache.camel.component.aws2.s3.AWS2S3Configuration 类型。 | AWS2S3Configuration | |
camel.component.aws2-s3.customer-algorithm | 定义在启用了 CustomerKey 时要使用的客户算法。 | 字符串 | |
camel.component.aws2-s3.customer-key-id | 定义在启用 CustomerKey 时要使用的 Customer key 的 id。 | 字符串 | |
camel.component.aws2-s3.customer-key-m-d5 | 定义在启用 CustomerKey 时要使用的客户密钥的 MD5。 | 字符串 | |
camel.component.aws2-s3.delete-after-read | 在检索后,从 S3 删除对象。只有在提交 Exchange 时,才会执行删除。如果进行回滚,则对象不会被删除。如果此选项为 false,则同一对象将被通过并再次在轮询上检索。因此,您需要使用路由中的 Idempotent Consumer EIP 来过滤重复项。您可以使用 AWS2S3Constants#BUClKET_NAME 和 AWS2S3Constants#KEY 标头过滤,或者只过滤 AWS2S3Constants#KEY 标头。 | true | 布尔值 |
camel.component.aws2-s3.delete-after-write | 在 S3 文件上传后删除文件对象。 | false | 布尔值 |
camel.component.aws2-s3.delimiter | com.amazonaws.services.s3.model.ListObjectsRequest 中使用的分隔符仅消耗我们感兴趣的对象。 | 字符串 | |
camel.component.aws2-s3.destination-bucket | 定义当 moveAfterRead 设置为 true 时必须移动对象的目标存储桶。 | 字符串 | |
camel.component.aws2-s3.destination-bucket-prefix | 定义在必须移动对象并将 moveAfterRead 设置为 true 时使用的目标存储桶前缀。 | 字符串 | |
camel.component.aws2-s3.destination-bucket-suffix | 定义在必须移动对象并将 moveAfterRead 设置为 true 时使用的目标存储桶后缀。 | 字符串 | |
camel.component.aws2-s3.done-file-name | 如果提供,Camel 仅在文件存在时使用文件。 | 字符串 | |
camel.component.aws2-s3.enabled | 是否启用 aws2-s3 组件的自动配置。这默认是启用的。 | 布尔值 | |
camel.component.aws2-s3.file-name | 要从具有给定文件名的存储桶获取对象。 | 字符串 | |
camel.component.aws2-s3.ignore-body | 如果为 true,则 S3 对象正文将完全忽略,如果设为 false,则 S3 对象将放入正文中。把它设置为 true,将覆盖 includeBody 选项定义的任何行为。 | false | 布尔值 |
camel.component.aws2-s3.include-body | 如果为 true,则 S3Object Exchange 将被使用并放入正文和关闭中。如果为 false,S3Object 流将原始放在正文中,标头将使用 S3 对象元数据设置。这个选项与 autocloseBody 选项密切相关。如果将 includeBody 设为 true,因为 S3Object 流将被消耗,然后也会关闭它,而在 includeBody false 时,它将是关闭 S3Object 流的调用者。但是,当 includeBody 为 false 时,将 autocloseBody 设置为 true,它将在交换完成时自动关闭 S3Object 流。 | true | 布尔值 |
camel.component.aws2-s3.include-folders | 如果为 true,将消费的文件夹/目录。如果是 false,则忽略它们,且不会为那些交换创建。 | true | 布尔值 |
camel.component.aws2-s3.key-name | 通过端点参数在存储桶中设置元素的密钥名称。 | 字符串 | |
camel.component.aws2-s3.lazy-start-producer | 生成者是否应懒惰启动 (在第一个消息中)。通过懒惰启动,您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动,并导致路由启动失败。通过懒惰启动,启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意,在处理第一个消息时,创建并启动生成者可能需要稍等时间,并延长处理的总处理时间。 | false | 布尔值 |
camel.component.aws2-s3.move-after-read | 在检索后,将对象从 S3 存储桶移到不同的存储桶。要完成操作,必须设置 destinationBucket 选项。仅当 Exchange 提交时,才会执行复制存储桶操作。如果进行回滚,则对象不会被移动。 | false | 布尔值 |
camel.component.aws2-s3.multi-part-upload | 如果为 true,则 camel 将上传带有多部分格式的文件,由 partSize 选项决定部分大小。 | false | 布尔值 |
camel.component.aws2-s3.naming-strategy | 在流上传模式中使用的命名策略。 | AWSS3NamingStrategyEnum | |
camel.component.aws2-s3.operation | 当用户不希望只进行上传时,要执行的操作。 | AWS2S3Operations | |
camel.component.aws2-s3.override-endpoint | 设置覆盖端点的需要。这个选项需要与 uriEndpointOverride 选项结合使用。 | false | 布尔值 |
camel.component.aws2-s3.part-size | 设置多部分上传中使用的 partSize,默认大小为 25M。 | 26214400 | Long |
camel.component.aws2-s3.pojo-request | 如果您想要将 POJO 请求用作正文。 | false | 布尔值 |
camel.component.aws2-s3.policy | 此队列的策略在 com.amazonaws.services.s3.AmazonS3#setBucketPolicy() 方法中设置。 | 字符串 | |
camel.component.aws2-s3.prefix | com.amazonaws.services.s3.model.ListObjectsRequest 中使用的前缀,仅用于消费我们感兴趣的对象。 | 字符串 | |
camel.component.aws2-s3.proxy-host | 在实例化 SQS 客户端时定义代理主机。 | 字符串 | |
camel.component.aws2-s3.proxy-port | 指定要在客户端定义中使用的代理端口。 | 整数 | |
camel.component.aws2-s3.proxy-protocol | 在实例化 S3 客户端时定义代理协议。 | 协议 | |
camel.component.aws2-s3.region | S3 客户端需要工作的区域。使用此参数时,配置将预期区域(如 ap-east-1)的小写名称,您需要使用名称 Region.EU_WEST_1.id()。 | 字符串 | |
camel.component.aws2-s3.restarting-policy | 在流上传模式中使用的重启策略。 | AWSS3RestartingPolicyEnum | |
camel.component.aws2-s3.secret-key | Amazon AWS Secret 密钥。 | 字符串 | |
camel.component.aws2-s3.storage-class | 在 com.amazonaws.services.s3.model.PutObjectRequest 请求中设置的存储类。 | 字符串 | |
camel.component.aws2-s3.streaming-upload-mode | 当流模式为 true 时,上传到存储桶将以流传输方式进行。 | false | 布尔值 |
camel.component.aws2-s3.streaming-upload-timeout | 在流上传模式为 true 时,此选项会将超时设置为完成上传。 | Long | |
camel.component.aws2-s3.trust-all-certificates | 如果要在覆盖端点时信任所有证书。 | false | 布尔值 |
camel.component.aws2-s3.uri-endpoint-override | 设置覆盖 uri 端点。这个选项需要与 overrideEndpoint 选项结合使用。 | 字符串 | |
camel.component.aws2-s3.use-aws-k-m-s | 定义是否必须使用 KMS。 | false | 布尔值 |
camel.component.aws2-s3.use-customer-key | 定义是否需要使用客户密钥。 | false | 布尔值 |
camel.component.aws2-s3.use-default-credentials-provider | 设置 S3 客户端是否应该希望通过默认凭据提供程序加载凭据,或者希望传递静态凭据。 | false | 布尔值 |