Package software.amazon.awscdk.services.kinesisfirehose

Interface OpenXJsonInputFormatProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OpenXJsonInputFormatProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:12.485Z")
@Stability(Stable)
public interface OpenXJsonInputFormatProps
extends software.amazon.jsii.JsiiSerializable

Props for OpenX JSON input format for data record format conversion.

Example:

 OpenXJsonInputFormat inputFormat = OpenXJsonInputFormat.Builder.create()
         .lowercaseColumnNames(false)
         .columnToJsonKeyMappings(Map.of("ts", "timestamp"))
         .convertDotsInJsonKeysToUnderscores(true)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OpenXJsonInputFormatProps.Builder	builder()
default Map<String,String>	getColumnToJsonKeyMappings()	Maps column names to JSON keys that aren't identical to the column names.
default Boolean	getConvertDotsInJsonKeysToUnderscores()	When set to true, specifies that the names of the keys include dots and that you want Firehose to replace them with underscores.
default Boolean	getLowercaseColumnNames()	Whether the JSON keys should be lowercased when written as column names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumnToJsonKeyMappings

@Stability(Stable)
@Nullable
default Map<String,String> getColumnToJsonKeyMappings()

Maps column names to JSON keys that aren't identical to the column names.

This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts

Default: JSON keys are not renamed

getConvertDotsInJsonKeysToUnderscores

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

When set to true, specifies that the names of the keys include dots and that you want Firehose to replace them with underscores.

This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.

Default: `false`

getLowercaseColumnNames

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

Whether the JSON keys should be lowercased when written as column names.

Default: `true`

builder

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

Returns:

a OpenXJsonInputFormatProps.Builder of OpenXJsonInputFormatProps