Amazon Kinesis Data Firehose API Reference
API Reference (API Version 2015-08-04)

OrcSerDe

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

Contents

BlockSizeBytes

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

Type: Integer

Valid Range: Minimum value of 67108864.

Required: No

BloomFilterColumns

The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.

Type: Array of strings

Pattern: ^\S+$

Required: No

BloomFilterFalsePositiveProbability

The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

Type: Double

Valid Range: Minimum value of 0. Maximum value of 1.

Required: No

Compression

The compression code to use over data blocks. The default is SNAPPY.

Type: String

Valid Values: NONE | ZLIB | SNAPPY

Required: No

DictionaryKeyThreshold

Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.

Type: Double

Valid Range: Minimum value of 0. Maximum value of 1.

Required: No

EnablePadding

Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false.

Type: Boolean

Required: No

FormatVersion

The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

Type: String

Valid Values: V0_11 | V0_12

Required: No

PaddingTolerance

A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.

For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.

Kinesis Data Firehose ignores this parameter when OrcSerDe:EnablePadding is false.

Type: Double

Valid Range: Minimum value of 0. Maximum value of 1.

Required: No

RowIndexStride

The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

Type: Integer

Valid Range: Minimum value of 1000.

Required: No

StripeSizeBytes

The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

Type: Integer

Valid Range: Minimum value of 8388608.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: