interface DataSourceToIndexFieldMappingProperty

Language	Type name
.NET	Amazon.CDK.AWS.Kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_DataSourceToIndexFieldMappingProperty
Java	software.amazon.awscdk.services.kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty
Python	aws_cdk.aws_kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty
TypeScript	aws-cdk-lib » aws_kendra » CfnDataSource » DataSourceToIndexFieldMappingProperty

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html

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

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

Properties

Name	Type	Description
dataSourceFieldName	string	The name of the field in the data source.
indexFieldName	string	The name of the index field to map to the data source field.
dateFieldFormat?	string	The format for date fields in the data source.

---

dataSourceFieldName

Type: string

The name of the field in the data source.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-datasourcefieldname

---

indexFieldName

Type: string

The name of the index field to map to the data source field.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-indexfieldname

---

dateFieldFormat?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-datefieldformat