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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb

Overview

Note:

When making an API call, you may pass RecordFormat data as a 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 an SQL-based Amazon Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

Constant Summary collapse

SENSITIVE =

[]

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)

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 4535

class RecordFormat < Struct.new(
  :record_format_type,
  :mapping_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#record_format_type ⇒ `String`

The type of record format.