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

Class: Aws::KinesisAnalytics::Types::RecordFormat

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/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
    },
  },
}

Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

Instance Attribute Summary collapse

Instance Attribute Details

#mapping_parametersTypes::MappingParameters

When configuring 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.



2166
2167
2168
2169
2170
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2166

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

#record_format_typeString

The type of record format.

Returns:

  • (String)


2166
2167
2168
2169
2170
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2166

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