Class CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty
Provides the configuration information for indexing Salesforce custom articles.
Inheritance
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SalesforceCustomKnowledgeArticleTypeConfigurationProperty : Object, CfnDataSource.ISalesforceCustomKnowledgeArticleTypeConfigurationProperty
Syntax (vb)
Public Class SalesforceCustomKnowledgeArticleTypeConfigurationProperty
Inherits Object
Implements CfnDataSource.ISalesforceCustomKnowledgeArticleTypeConfigurationProperty
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 salesforceCustomKnowledgeArticleTypeConfigurationProperty = new SalesforceCustomKnowledgeArticleTypeConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
Name = "name",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
};
Synopsis
Constructors
SalesforceCustomKnowledgeArticleTypeConfigurationProperty() |
Properties
DocumentDataFieldName | The name of the field in the custom knowledge article that contains the document data to index. |
DocumentTitleFieldName | The name of the field in the custom knowledge article that contains the document title. |
FieldMappings | Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. |
Name | The name of the configuration. |
Constructors
SalesforceCustomKnowledgeArticleTypeConfigurationProperty()
public SalesforceCustomKnowledgeArticleTypeConfigurationProperty()
Properties
DocumentDataFieldName
The name of the field in the custom knowledge article that contains the document data to index.
public string DocumentDataFieldName { get; set; }
Property Value
System.String
Remarks
DocumentTitleFieldName
The name of the field in the custom knowledge article that contains the document title.
public string DocumentTitleFieldName { get; set; }
Property Value
System.String
Remarks
FieldMappings
Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.
public object FieldMappings { get; set; }
Property Value
System.Object
Remarks
To create custom fields, use the UpdateIndex
API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.
Name
The name of the configuration.
public string Name { get; set; }
Property Value
System.String