5.3. 组件选项
AWS S3 Storage Service 组件支持 50 个选项,如下所示。
Name | 描述 | 默认 | 类型 |
---|---|---|---|
amazonS3Client (common) | 自动线 对 registry 中的 com.amazonaws.services.s3.AmazonS3 的引用。 | S3Client | |
amazonS3Presigner (common) | Autowired An S3 Presigner for Request,它们主要用于 createDownloadLink 操作。 | S3Presigner | |
autoCreateBucket (common) | 设置 S3 存储桶 bucketName 的自动记录。如果启用了 moveAfterRead 选项,它将创建 destinationBucket(如果尚未存在)。 | false | 布尔值 |
configuration (common) | 组件配置。 | AWS2S3Configuration | |
overrideEndpoint (common) | 设置覆盖端点的需求。这个选项必须与 uriEndpointOverride 选项结合使用。 | false | 布尔值 |
pojoRequest (common) | 如果我们想要将 POJO 请求用作正文或非其要求。 | false | 布尔值 |
policy (common) | 此队列的策略在 com.amazonaws.services.s3.AmazonS3#setBucketPolicy()方法中设置。 | 字符串 | |
proxyHost (common) | 在实例化 SQS 客户端时定义代理主机。 | 字符串 | |
proxyPort (common) | 指定要在客户端定义中使用的代理端口。 | 整数 | |
proxyProtocol (common) | 在实例化 S3 客户端时定义代理协议。 枚举值:
| 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 时定义要使用的客户密钥 ID。 | 字符串 | |
customerKeyMD5 (common (advanced)) | 在启用了 customerKey 时定义要使用的客户密钥 MD5。 | 字符串 | |
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由 Error Handler,这意味着在消费者尝试获取传入的消息时发生任何异常,或像这样一样处理,消息现在将被作为消息进行处理,并由路由 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 对象正文将被完全忽略,如果将 S3 对象设置为 false,则将放置在正文中。把它设置为 true,将覆盖 includeBody 选项定义的任何行为。 | false | 布尔值 |
includeBody (consumer) | 若为 true,则使用 S3Object 交换,并放入正文和关闭中。如果为 false,则 S3Object 流将原始数据放在正文中,标题将使用 S3 对象元数据来设置。这个选项与 autocloseBody 选项相关。如果设置 includeBody 为 true,因为 S3Object 流也会被使用,那么在 includeBody false 时,它将被关闭,然后是调用者以关闭 S3Object 流。但是,当 includeBody 为 false 时,将 autocloseBody 设置为 true,它将计划在交换完成后自动关闭 S3Object 流。 | true | 布尔值 |
includeFolders (consumer) | 若为 true,则使用文件夹/目录。如果为 false,将忽略它们,不会为它们创建 Exchanges。 | true | 布尔值 |
moveAfterRead (consumer) | 在检索后,将对象从 S3 存储桶移到不同的存储桶。要完成此操作,必须设置 destinationBucket 选项。只有在 Exchange 被提交时,才会执行复制存储桶操作。如果进行回滚,则对象不会被移动。 | false | 布尔值 |
前缀 (使用者) | com.amazonaws.services.s3.model.ListObjectsRequest 中使用的前缀,仅用于消耗我们感兴趣的对象。 | 字符串 | |
autocloseBody (consumer (advanced)) | 如果这个选项为 true,并且 includeBody 为 false,则在交换完成后会调用 S3Object.close()方法。这个选项与 includeBody 选项相关。如果将 includeBody 设为 false,则会自动关闭Body 为 false,则最多可看到调用者关闭 S3Object 流。将 autocloseBody 设置为 true,将自动关闭 S3Object 流。 | true | 布尔值 |
batchMessageNumber (producer) | 以流上传模式生成批处理的消息数量。 | 10 | int |
batchSize (producer) | 流传输上传模式的批处理大小(以字节为单位)。 | 1000000 | int |
deleteAfterWrite (producer) | 上传 S3 文件后删除文件对象。 | false | 布尔值 |
keyName (producer) | 通过 endpoint 参数设置 bucket 中元素的键名称。 | 字符串 | |
lazyStartProducer (producer) | 制作者是否应该启动 lazy(在第一个消息上)。通过启动 lazy,您可以使用它来允许 CamelContext 和路由在启动期间启动,否则在启动期间出现问题,并导致路由启动失败。通过将这个启动延迟到 lazy 后,可以在通过 Camel 的路由错误处理程序路由消息期间处理启动失败。注意在处理第一个消息时,创建并启动制作者可能花费较少的时间,从而延长处理的总处理时间。 | false | 布尔值 |
multiPartUpload (producer) | 如果是 true,则 camel 将使用多部分格式上传该文件,部分大小由 partSize 选项决定。 | false | 布尔值 |
namingStrategy (producer) | 在流传输上传模式中使用的命名策略。 枚举值:
| 渐进 | AWSS3NamingStrategyEnum |
operation (producer) | 当用户不想只进行上传时,要执行的操作。 枚举值:
| AWS2S3Operations | |
partSize (producer) | 设置在多部分上传中使用的 partSize,默认大小为 25M。 | 26214400 | long |
restartingPolicy (producer) | 在流传输上传模式中使用的重启策略。 枚举值:
| 覆盖 | 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 | 布尔值 |
autowiredEnabled (advanced) | 是否启用自动。这用于自动自动自动选项(选项必须标记为 autowired),方法是在 registry 中查找是否有匹配的类型实例,然后在组件上进行配置。这可用于自动配置 JDBC 数据源、JMS 连接工厂、AWS 客户端等。 | true | 布尔值 |
accesskey (安全性) | Amazon AWS 访问密钥. | 字符串 | |
secretKey (security) | Amazon AWS Secret 密钥。 | 字符串 |