interface OrcOutputFormatProps

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisFirehose.OrcOutputFormatProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#OrcOutputFormatProps`
Java	`software.amazon.awscdk.services.kinesisfirehose.OrcOutputFormatProps`
Python	`aws_cdk.aws_kinesisfirehose.OrcOutputFormatProps`
TypeScript (source)	`aws-cdk-lib` » `aws_kinesisfirehose` » `OrcOutputFormatProps`

Props for ORC output format for data record format conversion.

Example

const outputFormat = new firehose.OrcOutputFormat({
  formatVersion: firehose.OrcFormatVersion.V0_11,
  blockSize: Size.mebibytes(256),
  compression: firehose.OrcCompression.NONE,
  bloomFilterColumns: ['columnA'],
  bloomFilterFalsePositiveProbability: 0.1,
  dictionaryKeyThreshold: 0.7,
  enablePadding: true,
  paddingTolerance: 0.2,
  rowIndexStride: 9000,
  stripeSize: Size.mebibytes(32),
})

Properties

Name	Type	Description
blockSize?	`Size`	The Hadoop Distributed File System (HDFS) block size.
bloomFilterColumns?	`string[]`	The column names for which you want Firehose to create bloom filters.
bloomFilterFalsePositiveProbability?	`number`	The Bloom filter false positive probability (FPP).
compression?	`OrcCompression`	The compression code to use over data blocks.
dictionaryKeyThreshold?	`number`	Determines whether dictionary encoding should be applied to a column.
enablePadding?	`boolean`	Set this to `true` to indicate that you want stripes to be padded to the HDFS block boundaries.
formatVersion?	`OrcFormatVersion`	The version of the ORC format to write.
paddingTolerance?	`number`	A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size.
rowIndexStride?	`number`	The number of rows between index entries.
stripeSize?	`Size`	The number of bytes in each stripe.

blockSize?

Type: Size (optional, default: Size.mebibytes(256))

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. Firehose uses this value for padding calculations.

bloomFilterColumns?

Type: string[] (optional, default: no bloom filters are created)

The column names for which you want Firehose to create bloom filters.

bloomFilterFalsePositiveProbability?

Type: number (optional, default: 0.05)

The Bloom filter false positive probability (FPP).

The lower the FPP, the bigger the bloom filter.

compression?

Type: OrcCompression (optional, default: SNAPPY)

The compression code to use over data blocks.

The possible values are NONE , SNAPPY , and ZLIB. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

dictionaryKeyThreshold?

Type: number (optional, default: 0.8)

Determines whether dictionary encoding should be applied to a column.

If the number of distinct keys (unique values) in a column exceeds this fraction of the total non-null rows in that column, dictionary encoding will be turned off for that specific column.

To turn off dictionary encoding, set this threshold to 0. To always use dictionary encoding, set this threshold to 1.

enablePadding?

Type: boolean (optional, default: false)

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.

formatVersion?

Type: OrcFormatVersion (optional, default: V0_12)

The version of the ORC format to write.

The possible values are V0_11 and V0_12.

paddingTolerance?

Type: number (optional, default: 0.05 if enablePadding is true)

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 EnablePadding is false .

rowIndexStride?

Type: number (optional, default: 10000)

The number of rows between index entries.

stripeSize?

Type: Size (optional, default: Size.mebibytes(64))

The number of bytes in each stripe.

The default is 64 MiB and the minimum is 8 MiB.