16.3. 配置选项

bucketNameOrArn *

bucket 名称

S3 Bucket 名称或 Amazon Resource Name (ARN)。

字符串

region *

AWS 区域

用于访问的 AWS 区域。

字符串

accessKey

访问密钥

从 AWS 获取的访问密钥。

字符串

autoCreateBucket

autocreate Bucket

指定自动创建 S3 存储桶。

布尔值

False

delay

delay

下一次轮询所选存储桶前的毫秒数。

整数

500

deleteAfterRead

自动删除对象

指定在消耗对象后删除对象。

布尔值

True

destinationBucket

目标 Bucket

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

字符串

destinationBucketPrefix

目标 Bucket Prefix

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

字符串

destinationBucketSuffix

目标 Bucket Suffix

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

字符串

forcePathStyle

强制路径样式

在访问 AWS S3 存储桶时强制路径风格。

布尔值

False

ignoreBody

忽略正文

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

布尔值

False

maxMessagesPerPoll

每个 Poll 的最大消息

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

整数

10

moveAfterRead

在删除后移动对象

在检索后，将对象从 S3 存储桶移到不同的存储桶。

布尔值

False

overrideEndpoint

端点覆盖

选择这个选项来覆盖端点 URI。要使用这个选项，还必须为 uriEndpointOverride 选项提供 URI。

布尔值

False

prefix

prefix

搜索时需要考虑的 AWS S3 存储桶前缀。

字符串

folder/

profileCredentialsName

配置集凭证名称

如果使用配置集凭证供应商，此参数会设置配置集名称。

字符串

secretKey

机密密钥

从 AWS 获取的 secret 密钥。

字符串

sessionToken

会话令牌

当用户需要假定 IAM 角色时使用的 Amazon AWS Session Token。

字符串

uriEndpointOverride

覆盖 Endpoint URI

覆盖端点 URI。要使用这个选项，还必须选择 overrideEndpoint 选项。

字符串

useDefaultCredentialsProvider

默认凭证提供程序

如果为 true，S3 客户端会通过默认凭证供应商加载凭证。如果为 false，它将使用基本的身份验证方法(access key 和 secret key)。

布尔值

False

useProfileCredentialsProvider

配置集凭证供应商

设置 S3 客户端是否应该预期通过配置集凭据提供程序加载凭据。

布尔值

False

useSessionCredentials

会话凭证

设置 S3 客户端是否应该预期使用 Session Credentials。这在用户需要假设 IAM 角色在 S3 中执行操作时非常有用。

布尔值

False