Skip to content
v2.274.0

ColumnConfigurationProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const columnConfigurationProperty: kendra.CfnDataSource.ColumnConfigurationProperty = {
  changeDetectingColumns: ['changeDetectingColumns'],
  documentDataColumnName: 'documentDataColumnName',
  documentIdColumnName: 'documentIdColumnName',

  // the properties below are optional
  documentTitleColumnName: 'documentTitleColumnName',
  fieldMappings: [{
    dataSourceFieldName: 'dataSourceFieldName',
    indexFieldName: 'indexFieldName',

    // the properties below are optional
    dateFieldFormat: 'dateFieldFormat',
  }],
};

Properties ​

changeDetectingColumnsstring[]change_detecting_columnstyping.List[str]changeDetectingColumnsList<String>ChangeDetectingColumnsstring[]ChangeDetectingColumns*[]*stringrequired#
One to five columns that indicate when a document in the database has changed.
documentDataColumnNamestringdocument_data_column_namestrdocumentDataColumnNameStringDocumentDataColumnNamestringDocumentDataColumnName*stringrequired#
The column that contains the contents of the document.
documentIdColumnNamestringdocument_id_column_namestrdocumentIdColumnNameStringDocumentIdColumnNamestringDocumentIdColumnName*stringrequired#
The column that provides the document's identifier.
documentTitleColumnNameoptionalstringdocument_title_column_nameoptionalstrdocumentTitleColumnNameoptionalStringDocumentTitleColumnNameoptionalstringDocumentTitleColumnNameoptional*string#
The column that contains the title of the document.
fieldMappingsoptionalIResolvable | IResolvable | CfnDataSource.DataSourceToIndexFieldMappingProperty[]field_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceToIndexFieldMappingProperty]]]fieldMappingsoptionalIResolvableFieldMappingsoptionalIResolvableFieldMappingsoptionalinterface{}#
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.