Amazon S3 对象的自定义前缀 - Amazon Kinesis Data Firehose
timestamp 命名空间firehose 命名空间partitionKeyFromLambda 和 partitionKeyFromQuery 命名空间语义规则示例前缀
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

Amazon S3 对象的自定义前缀

如果您的目标是 Amazon S3、Amazon OpenSearch Service 或 Splunk，则可以配置 Amazon S3 对象键，用于从 Kinesis Data Firehose 传输数据。要执行此操作，请指定 Kinesis Data Firehose 在传输时计算的表达式。最终对象键的格式为 <evaluated prefix><suffix>，其中后缀格式为 <delivery stream name>-<delivery stream version>-<year>-<month>-<day>-<hour>-<minute>-<second>-<uuid><file extension>。您无法更改后缀字段。

您可以在自定义前缀中使用以下形式的表达式：!{namespace:value}，其中 namespace 可以是以下形式之一，如以下各部分所述。

  • firehose

  • timestamp

  • partitionKeyFromQuery

  • partitionKeyFromLambda

如果前缀以斜杠结束，则在 Amazon S3 存储桶中将显示为文件夹。有关更多信息，请参阅《Amazon Kinesis Data Firehose 开发人员指南》中的 Amazon S3 对象名称格式。

timestamp 命名空间

此命名空间的有效值是作为有效 Java DateTimeFormatter 字符串的字符串。例如，对于 2018 年，表达式 !{timestamp:yyyy} 的计算结果为 2018。

在计算时间戳时，Kinesis Data Firehose 将使用所写入 Amazon S3 对象中包含的最早记录的大致到达时间戳。

时间戳始终以 UTC 表示。

如果您在同一前缀表达式中多次使用 timestamp 命名空间，则每个实例的计算结果为同一时刻。

firehose 命名空间

您可以将两个值用于此命名空间：error-output-type 和 random-string。下表介绍了其使用方法。

firehose 命名空间值
转换 描述 示例输入 输出示例 注意
error-output-type 根据传输流的配置和失败原因，计算结果为下列字符串之一：{processing-failed、AmazonOpenSearchService-failed、splunk-failed、format-conversion-failed、http-endpoint-failed}。

如果您在同一表达式中多次使用它，则每个实例的计算结果为同一错误字符串。

 myPrefix/result=!{firehose:error-output-type}/!{timestamp:yyyy/MM/dd} myPrefix/result=processing-failed/2018/08/03 error-output-type 值只能在 ErrorOutputPrefix 字段中使用。
random-string

计算结果为 11 个字符的随机字符串。如果您在同一表达式中多次使用它，则每个实例的计算结果为一个新的随机字符串。

 myPrefix/!{firehose:random-string}/ myPrefix/046b6c7f-0b/ 您可以将它用于这两种前缀类型。

您可以将此字符串放在格式字符串的开头以获取随机前缀，若想使用 Amazon S3 获得极高的吞吐量，此操作有时十分必要。

partitionKeyFromLambda 和 partitionKeyFromQuery 命名空间

对于动态分区，您必须在 S3 存储桶前缀中使用以下表达式格式：!{namespace:value}，其中命名空间可以是 partitionKeyFromQuery 或 partitionKeyFromLambda，也可以是两者。如果使用内联解析为源数据创建分区键，则必须指定一个 S3 存储桶前缀值，该值由以下格式指定的表达式组成："partitionKeyFromQuery:keyID"。如果使用 Amazon Lambda 函数为源数据创建分区键，则必须指定一个 S3 存储桶前缀值，该值由以下格式指定的表达式组成："partitionKeyFromLambda:keyID"。有关更多信息，请参阅创建 Amazon Kinesis Data Firehose 传输流中的“选择 Amazon S3 作为目标”。

语义规则

以下规则适用于 Prefix 和 ErrorOutputPrefix 表达式。

  • 对于 timestamp 命名空间，将计算未包含在单引号内的任何字符。换句话说，将按字面意思处理值字段中使用单引号进行转义的任何字符串。

  • 如果指定的前缀不包含时间戳名称空间表达式，则 Kinesis Data Firehose 会将该表达式!{timestamp:yyyy/MM/dd/HH/}追加到 Prefix 字段中的值。

  • 序列 !{ 只能出现在 !{namespace:value} 表达式中。

  • 仅当 Prefix 未包含任何表达式时，ErrorOutputPrefix 才能为空。在这种情况下，Prefix 的计算结果为 <specified-prefix>yyyy/MM/DDD/HH/，ErrorOutputPrefix 计算结果为 <specified-prefix><error-output-type>YYYY/MM/DDD/HH/。DDD 表示一年中的某天。

  • 如果您为 ErrorOutputPrefix 指定一个表达式，则您必须包含至少一个 !{firehose:error-output-type} 实例。

  • Prefix 无法包含 !{firehose:error-output-type}。

  • Prefix 和 ErrorOutputPrefix 在计算后都不能超过 512 个字符。

  • 如果目标位置是 Amazon Redshift，则 Prefix 不能包含表达式并且 ErrorOutputPrefix 必须为空。

  • 当目标位置是 Amazon OpenSearch Service 或 Splunk，并且未指定 ErrorOutputPrefix 时，Kinesis Data Firehose 将对失败的记录使用 Prefix 字段。

  • 当目标位置是 Amazon S3 时，Amazon S3 目标配置中的 Prefix 和 ErrorOutputPrefix 将分别用于成功记录和失败记录。如果使用 Amazon CLI 或 API，则可使用 ExtendedS3DestinationConfiguration 指定具有自己的 Prefix 和 ErrorOutputPrefix 的 Amazon S3 备份配置。

  • 当您使用 Amazon Web Services Management Console 并将目标位置设置为 Amazon S3 时，Kinesis Data Firehose 会将目标配置中的 ErrorOutputPrefix 和 Prefix 分别用于成功记录和失败记录。如果指定了前缀但没有错误前缀，Kinesis Data Firehose 会自动将错误前缀设置为 !{firehose:error-output-type}/。

  • 当通过 Amazon CLI、API 或 Amazon CloudFormation 使用 ExtendedS3DestinationConfiguration 时，如果您指定 S3BackupConfiguration，则 Kinesis Data Firehose 不提供默认 ErrorOutputPrefix。

  • 在创建 ErrorOutputPrefix 表达式时，不能使用 partitionKeyFromLambda 和 partitionKeyFromQuery 命名空间。

示例前缀

Prefix 和 ErrorOutputPrefix 示例
输入 计算的前缀 [2018 年 8 月 27 日上午 10:30（UTC）]

Prefix：未指定

ErrorOutputPrefix: myFirehoseFailures/!{firehose:error-output-type}/

Prefix: 2018/08/27/10

ErrorOutputPrefix: myFirehoseFailures/processing-failed/

Prefix: !{timestamp:yyyy/MM/dd}

ErrorOutputPrefix：未指定

 输入无效：当 Prefix 包含表达式时，ErrorOutputPrefix 不能为空

Prefix: myFirehose/DeliveredYear=!{timestamp:yyyy}/anyMonth/rand=!{firehose:random-string}

ErrorOutputPrefix: myFirehoseFailures/!{firehose:error-output-type}/!{timestamp:yyyy}/anyMonth/!{timestamp:dd}

Prefix: myFirehose/DeliveredYear=2018/anyMonth/rand=5abf82daaa5

ErrorOutputPrefix: myFirehoseFailures/processing-failed/2018/anyMonth/10

Prefix: myPrefix/year=!{timestamp:yyyy}/month=!{timestamp:MM}/day=!{timestamp:dd}/hour=!{timestamp:HH}/

ErrorOutputPrefix: myErrorPrefix/year=!{timestamp:yyyy}/month=!{timestamp:MM}/day=!{timestamp:dd}/hour=!{timestamp:HH}/!{firehose:error-output-type}

Prefix: myPrefix/year=2018/month=07/day=06/hour=23/

ErrorOutputPrefix: myErrorPrefix/year=2018/month=07/day=06/hour=23/processing-failed

Prefix: myFirehosePrefix

ErrorOutputPrefix：未指定

Prefix: myFirehosePrefix/2018/08/27/

ErrorOutputPrefix: myFirehosePrefix/processing-failed/2018/08/27/