Class CfnDataSource.ConfluencePageToIndexFieldMappingProperty
Maps attributes or field names of Confluence pages to Amazon Kendra index field names.
Inheritance
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ConfluencePageToIndexFieldMappingProperty : Object, CfnDataSource.IConfluencePageToIndexFieldMappingProperty
Syntax (vb)
Public Class ConfluencePageToIndexFieldMappingProperty
Inherits Object
Implements CfnDataSource.IConfluencePageToIndexFieldMappingProperty
Remarks
To create custom fields, use the UpdateIndex
API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.
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 confluencePageToIndexFieldMappingProperty = new ConfluencePageToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
};
Synopsis
Constructors
ConfluencePageToIndexFieldMappingProperty() |
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 Confluence data source field. |
Constructors
ConfluencePageToIndexFieldMappingProperty()
public ConfluencePageToIndexFieldMappingProperty()
Properties
DataSourceFieldName
The name of the field in the data source.
public string DataSourceFieldName { get; set; }
Property Value
System.String
Remarks
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 Confluence data source field.
public string IndexFieldName { get; set; }
Property Value
System.String
Remarks
The index field type must match the Confluence field type.