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

Class: Aws::KinesisAnalytics::Types::ReferenceDataSource

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 ReferenceDataSource data as a hash:

{
  table_name: "InAppTableName", # required
  s3_reference_data_source: {
    bucket_arn: "BucketARN", # required
    file_key: "FileKey", # required
    reference_role_arn: "RoleARN", # required
  },
  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
      },
    ],
  },
}

Describes the reference data source by providing the source information (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.

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:



2570
2571
2572
2573
2574
2575
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2570

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

#s3_reference_data_sourceTypes::S3ReferenceDataSource

Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.

An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.



2570
2571
2572
2573
2574
2575
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2570

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

#table_nameString

Name of the in-application table to create.

Returns:

  • (String)


2570
2571
2572
2573
2574
2575
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2570

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