Interface CfnDataSource.IColumnConfigurationProperty
Provides information about how Amazon Kendra should use the columns of a database in an index.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IColumnConfigurationProperty
Syntax (vb)
Public Interface IColumnConfigurationProperty
Remarks
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 columnConfigurationProperty = new ColumnConfigurationProperty {
ChangeDetectingColumns = new [] { "changeDetectingColumns" },
DocumentDataColumnName = "documentDataColumnName",
DocumentIdColumnName = "documentIdColumnName",
// the properties below are optional
DocumentTitleColumnName = "documentTitleColumnName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
};
Synopsis
Properties
ChangeDetectingColumns | One to five columns that indicate when a document in the database has changed. |
DocumentDataColumnName | The column that contains the contents of the document. |
DocumentIdColumnName | The column that provides the document's identifier. |
DocumentTitleColumnName | The column that contains the title of the document. |
FieldMappings | An array of objects that map database column names to the corresponding fields in an index. |
Properties
ChangeDetectingColumns
One to five columns that indicate when a document in the database has changed.
string[] ChangeDetectingColumns { get; }
Property Value
System.String[]
Remarks
DocumentDataColumnName
The column that contains the contents of the document.
string DocumentDataColumnName { get; }
Property Value
System.String
Remarks
DocumentIdColumnName
The column that provides the document's identifier.
string DocumentIdColumnName { get; }
Property Value
System.String
Remarks
DocumentTitleColumnName
The column that contains the title of the document.
virtual string DocumentTitleColumnName { get; }
Property Value
System.String
Remarks
FieldMappings
An array of objects that map database column names to the corresponding fields in an index.
virtual object FieldMappings { get; }
Property Value
System.Object
Remarks
You must first create the fields in the index using the UpdateIndex operation.