AWS::KinesisFirehose::DeliveryStream OrcSerDe - AWS CloudFormation
SyntaxProperties

AWS::KinesisFirehose::DeliveryStream OrcSerDe

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BlockSizeBytes" : Integer,
  "BloomFilterColumns" : [ String, ... ],
  "BloomFilterFalsePositiveProbability" : Number,
  "Compression" : String,
  "DictionaryKeyThreshold" : Number,
  "EnablePadding" : Boolean,
  "FormatVersion" : String,
  "PaddingTolerance" : Number,
  "RowIndexStride" : Integer,
  "StripeSizeBytes" : Integer
}

Properties

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

Required: No

Type: Integer

Minimum: 67108864

Update requires: No interruption

BloomFilterColumns

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

Required: No

Type: Array of String

Update requires: No interruption

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.

Required: No

Type: Number

Update requires: No interruption

Compression

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

Required: No

Type: String

Allowed values: NONE | ZLIB | SNAPPY

Update requires: No interruption

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.

Required: No

Type: Number

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

FormatVersion

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

Required: No

Type: String

Allowed values: V0_11 | V0_12

Update requires: No interruption

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

Required: No

Type: Number

Update requires: No interruption

RowIndexStride

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

Required: No

Type: Integer

Minimum: 1000

Update requires: No interruption

StripeSizeBytes

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

Required: No

Type: Integer

Minimum: 8388608

Update requires: No interruption