You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KinesisAnalyticsV2::Types::RecordFormat

Inherits:

Struct

Object
Struct
Aws::KinesisAnalyticsV2::Types::RecordFormat

show all

Defined in:: (unknown)

Overview

Note:

When passing RecordFormat as input to an Aws::Client method, you can use a vanilla Hash:

{
  record_format_type: "JSON", # required, accepts JSON, CSV
  mapping_parameters: {
    json_mapping_parameters: {
      record_row_path: "RecordRowPath", # required
    },
    csv_mapping_parameters: {
      record_row_delimiter: "RecordRowDelimiter", # required
      record_column_delimiter: "RecordColumnDelimiter", # required
    },
  },
}

For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

Returned by:

Instance Attribute Summary collapse

#mapping_parameters ⇒ Types::MappingParameters
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
#record_format_type ⇒ String
The type of record format.

Instance Attribute Details

#mapping_parameters ⇒ `Types::MappingParameters`

When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

Returns:

(Types::MappingParameters) —
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

#record_format_type ⇒ `String`

The type of record format.

Possible values:

JSON
CSV