Class: Aws::KinesisAnalyticsV2::Types::ReferenceDataSource

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb

Overview

Note:

When making an API call, you may pass ReferenceDataSource data as a hash:

{
  table_name: "InAppTableName", # required
  s3_reference_data_source: {
    bucket_arn: "BucketARN",
    file_key: "FileKey",
  },
  reference_schema: { # required
    record_format: { # required
      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
        },
      },
    },
    record_encoding: "RecordEncoding",
    record_columns: [ # required
      {
        name: "RecordColumnName", # required
        mapping: "RecordColumnMapping",
        sql_type: "RecordColumnSqlType", # required
      },
    ],
  },
}

For an SQL-based Amazon Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#reference_schemaTypes::SourceSchema

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

Returns:



4600
4601
4602
4603
4604
4605
4606
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 4600

class ReferenceDataSource < Struct.new(
  :table_name,
  :s3_reference_data_source,
  :reference_schema)
  SENSITIVE = []
  include Aws::Structure
end

#s3_reference_data_sourceTypes::S3ReferenceDataSource

Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.



4600
4601
4602
4603
4604
4605
4606
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 4600

class ReferenceDataSource < Struct.new(
  :table_name,
  :s3_reference_data_source,
  :reference_schema)
  SENSITIVE = []
  include Aws::Structure
end

#table_nameString

The name of the in-application table to create.

Returns:

  • (String)


4600
4601
4602
4603
4604
4605
4606
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 4600

class ReferenceDataSource < Struct.new(
  :table_name,
  :s3_reference_data_source,
  :reference_schema)
  SENSITIVE = []
  include Aws::Structure
end