Skip to content
v2.273.0

DataSourceToIndexFieldMappingProperty Struct ​

Maps a column or attribute in the data source to an index field.

You must first create the fields in the index using the UpdateIndex operation.

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 dataSourceToIndexFieldMappingProperty: kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty = {
  dataSourceFieldName: 'dataSourceFieldName',
  indexFieldName: 'indexFieldName',

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

Properties ​

dataSourceFieldNamestringdata_source_field_namestrdataSourceFieldNameStringDataSourceFieldNamestringDataSourceFieldName*stringrequired#
The name of the field in the data source.

You must first create the index field using the UpdateIndex API.

dateFieldFormatstringdate_field_formatstrdateFieldFormatStringDateFieldFormatstringDateFieldFormat*string#
The format for date fields in the data source.

If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.

indexFieldNamestringindex_field_namestrindexFieldNameStringIndexFieldNamestringIndexFieldName*stringrequired#
The name of the index field to map to the data source field.

The index field type must match the data source field type.