Package software.amazon.awscdk.services.kinesisfirehose

Interface ParquetOutputFormatProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ParquetOutputFormatProps.Jsii$Proxy

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

Props for Parquet output format for data record format conversion.

Example:

 ParquetOutputFormat outputFormat = ParquetOutputFormat.Builder.create()
         .blockSize(Size.mebibytes(512))
         .compression(ParquetCompression.UNCOMPRESSED)
         .enableDictionaryCompression(true)
         .maxPadding(Size.bytes(10))
         .pageSize(Size.mebibytes(2))
         .writerVersion(ParquetWriterVersion.V2)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ParquetOutputFormatProps.Builder	builder()
default Size	getBlockSize()	The Hadoop Distributed File System (HDFS) block size.
default ParquetCompression	getCompression()	The compression code to use over data blocks.
default Boolean	getEnableDictionaryCompression()	Indicates whether to enable dictionary compression.
default Size	getMaxPadding()	The maximum amount of padding to apply.
default Size	getPageSize()	The Parquet page size.
default ParquetWriterVersion	getWriterVersion()	Indicates the version of Parquet to output.

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)`

getCompression

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

The compression code to use over data blocks.

The possible values are UNCOMPRESSED , SNAPPY , and GZIP. 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/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-compression

getEnableDictionaryCompression

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

Indicates whether to enable dictionary compression.

Default: `false`

See Also:

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

getMaxPadding

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

The maximum amount of padding to apply.

This is useful if you intend to copy the data from Amazon S3 to HDFS before querying.

Default: no padding is applied

See Also:

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

getPageSize

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

The Parquet page size.

Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

Default: `Size.mebibytes(1)`

See Also:

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

getWriterVersion

@Stability(Stable)
@Nullable
default ParquetWriterVersion getWriterVersion()

Indicates the version of Parquet to output.

The possible values are V1 and V2

Default: `V1`

See Also:

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

builder

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

Returns:

a ParquetOutputFormatProps.Builder of ParquetOutputFormatProps