Package software.amazon.awscdk.services.kinesisfirehose

Interface OrcOutputFormatProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OrcOutputFormatProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:40.988Z")
@Stability(Stable)
public interface OrcOutputFormatProps
extends software.amazon.jsii.JsiiSerializable

Props for ORC output format for data record format conversion.

Example:

 OrcOutputFormat outputFormat = OrcOutputFormat.Builder.create()
         .formatVersion(OrcFormatVersion.V0_11)
         .blockSize(Size.mebibytes(256))
         .compression(OrcCompression.NONE)
         .bloomFilterColumns(List.of("columnA"))
         .bloomFilterFalsePositiveProbability(0.1)
         .dictionaryKeyThreshold(0.7)
         .enablePadding(true)
         .paddingTolerance(0.2)
         .rowIndexStride(9000)
         .stripeSize(Size.mebibytes(32))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	OrcOutputFormatProps.Builder	A builder for OrcOutputFormatProps
static final class	OrcOutputFormatProps.Jsii$Proxy	An implementation for OrcOutputFormatProps

Method Summary

Modifier and Type	Method	Description
static OrcOutputFormatProps.Builder	builder()
default Size	getBlockSize()	The Hadoop Distributed File System (HDFS) block size.
default List<String>	getBloomFilterColumns()	The column names for which you want Firehose to create bloom filters.
default Number	getBloomFilterFalsePositiveProbability()	The Bloom filter false positive probability (FPP).
default OrcCompression	getCompression()	The compression code to use over data blocks.
default Number	getDictionaryKeyThreshold()	Determines whether dictionary encoding should be applied to a column.
default Boolean	getEnablePadding()	Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries.
default OrcFormatVersion	getFormatVersion()	The version of the ORC format to write.
default Number	getPaddingTolerance()	A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size.
default Number	getRowIndexStride()	The number of rows between index entries.
default Size	getStripeSize()	The number of bytes in each stripe.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBlockSize

@Stability(Stable)
@Nullable
default Size getBlockSize()

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.

Default: `Size.mebibytes(256)`

getBloomFilterColumns

@Stability(Stable)
@Nullable
default List<String> getBloomFilterColumns()

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

Default: no bloom filters are created

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfiltercolumns

getBloomFilterFalsePositiveProbability

@Stability(Stable)
@Nullable
default Number getBloomFilterFalsePositiveProbability()

The Bloom filter false positive probability (FPP).

The lower the FPP, the bigger the bloom filter.

Default: `0.05`

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfilterfalsepositiveprobability

getCompression

@Stability(Stable)
@Nullable
default OrcCompression getCompression()

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.

Default: `SNAPPY`

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-compression

getDictionaryKeyThreshold

@Stability(Stable)
@Nullable
default Number getDictionaryKeyThreshold()

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.

Default: `0.8`

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-dictionarykeythreshold

getEnablePadding

@Stability(Stable)
@Nullable
default Boolean getEnablePadding()

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.

Default: `false`

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-enablepadding

getFormatVersion

@Stability(Stable)
@Nullable
default OrcFormatVersion getFormatVersion()

The version of the ORC format to write.

The possible values are V0_11 and V0_12.

Default: `V0_12`

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-formatversion

getPaddingTolerance

@Stability(Stable)
@Nullable
default Number getPaddingTolerance()

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 .

Default: `0.05` if `enablePadding` is `true`

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-paddingtolerance

getRowIndexStride

@Stability(Stable)
@Nullable
default Number getRowIndexStride()

The number of rows between index entries.

Default: 10000

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-rowindexstride

getStripeSize

@Stability(Stable)
@Nullable
default Size getStripeSize()

The number of bytes in each stripe.

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

Default: `Size.mebibytes(64)`

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-stripesizebytes

builder

@Stability(Stable)
static OrcOutputFormatProps.Builder builder()

Returns:

a OrcOutputFormatProps.Builder of OrcOutputFormatProps