Class CfnDataSource.DataSourceToIndexFieldMappingProperty
Maps a column or attribute in the data source to an index field.
Inheritance
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DataSourceToIndexFieldMappingProperty : Object, CfnDataSource.IDataSourceToIndexFieldMappingProperty
Syntax (vb)
Public Class DataSourceToIndexFieldMappingProperty
Inherits Object
Implements CfnDataSource.IDataSourceToIndexFieldMappingProperty
Remarks
You must first create the fields in the index using the UpdateIndex operation.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var dataSourceToIndexFieldMappingProperty = new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
};
Synopsis
Constructors
DataSourceToIndexFieldMappingProperty() |
Properties
DataSourceFieldName | The name of the field in the data source. |
DateFieldFormat | The format for date fields in the data source. |
IndexFieldName | The name of the index field to map to the data source field. |
Constructors
DataSourceToIndexFieldMappingProperty()
public DataSourceToIndexFieldMappingProperty()
Properties
DataSourceFieldName
The name of the field in the data source.
public string DataSourceFieldName { get; set; }
Property Value
System.String
Remarks
You must first create the index field using the UpdateIndex
API.
DateFieldFormat
The format for date fields in the data source.
public string DateFieldFormat { get; set; }
Property Value
System.String
Remarks
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.
IndexFieldName
The name of the index field to map to the data source field.
public string IndexFieldName { get; set; }
Property Value
System.String
Remarks
The index field type must match the data source field type.