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

Class: Aws::Kendra::Types::ColumnConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

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

{
  document_id_column_name: "ColumnName", # required
  document_data_column_name: "ColumnName", # required
  document_title_column_name: "ColumnName",
  field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  change_detecting_columns: ["ColumnName"], # required
}

Provides information about how Amazon Kendra should use the columns of a database in an index.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#change_detecting_columns ⇒ Array<String>

One to five columns that indicate when a document in the database has changed.

Returns:

  • (Array<String>) —

    One to five columns that indicate when a document in the database has changed.

#document_data_column_name ⇒ String

The column that contains the contents of the document.

Returns:

  • (String) —

    The column that contains the contents of the document.

#document_id_column_name ⇒ String

The column that provides the document\'s unique identifier.

Returns:

  • (String) —

    The column that provides the document\'s unique identifier.

#document_title_column_name ⇒ String

The column that contains the title of the document.

Returns:

  • (String) —

    The column that contains the title of the document.

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

Returns: