aws-cdk-lib.aws_kendra.CfnDataSource.ColumnConfigurationProperty

interface ColumnConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.ColumnConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_ColumnConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.ColumnConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.ColumnConfigurationProperty
TypeScript aws-cdk-lib » aws_kendra » CfnDataSource » ColumnConfigurationProperty

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

Example

// 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

NameTypeDescription
changeDetectingColumnsstring[]One to five columns that indicate when a document in the database has changed.
documentDataColumnNamestringThe column that contains the contents of the document.
documentIdColumnNamestringThe column that provides the document's identifier.
documentTitleColumnName?stringThe column that contains the title of the document.
fieldMappings?IResolvable | IResolvable | DataSourceToIndexFieldMappingProperty[]An array of objects that map database column names to the corresponding fields in an index.

changeDetectingColumns

Type: string[]

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


documentDataColumnName

Type: string

The column that contains the contents of the document.


documentIdColumnName

Type: string

The column that provides the document's identifier.


documentTitleColumnName?

Type: string (optional)

The column that contains the title of the document.


fieldMappings?

Type: IResolvable | IResolvable | DataSourceToIndexFieldMappingProperty[] (optional)

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.