interface OpenXJsonInputFormatProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.KinesisFirehose.OpenXJsonInputFormatProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#OpenXJsonInputFormatProps |
 Java | software.amazon.awscdk.services.kinesisfirehose.OpenXJsonInputFormatProps |
 Python | aws_cdk.aws_kinesisfirehose.OpenXJsonInputFormatProps |
 TypeScript (source) | aws-cdk-lib » aws_kinesisfirehose » OpenXJsonInputFormatProps |
Props for OpenX JSON input format for data record format conversion.
Example
const inputFormat = new firehose.OpenXJsonInputFormat({
lowercaseColumnNames: false,
columnToJsonKeyMappings: {"ts": "timestamp"},
convertDotsInJsonKeysToUnderscores: true,
})
Properties
| Name | Type | Description |
|---|---|---|
| column | { [string]: string } | Maps column names to JSON keys that aren't identical to the column names. |
| convert | boolean | When set to true, specifies that the names of the keys include dots and that you want Firehose to replace them with underscores. |
| lowercase | boolean | Whether the JSON keys should be lowercased when written as column names. |
columnToJsonKeyMappings?
Type:
{ [string]: string }
(optional, default: JSON keys are not renamed)
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
convertDotsInJsonKeysToUnderscores?
Type:
boolean
(optional, default: false)
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.
lowercaseColumnNames?
Type:
boolean
(optional, default: true)
Whether the JSON keys should be lowercased when written as column names.