SalesforceCustomKnowledgeArticleTypeConfigurationProperty Struct
Provides the configuration information for indexing Salesforce custom articles.
Example
ts
// 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 salesforceCustomKnowledgeArticleTypeConfigurationProperty: kendra.CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty = {
documentDataFieldName: 'documentDataFieldName',
name: 'name',
// the properties below are optional
documentTitleFieldName: 'documentTitleFieldName',
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
};
Properties
documentDataFieldNamestringdocument_data_field_namestrdocumentDataFieldNameStringDocumentDataFieldNamestringDocumentDataFieldName*stringrequired#The name of the field in the custom knowledge article that contains the document data to index.
documentTitleFieldNameoptionalstringdocument_title_field_nameoptionalstrdocumentTitleFieldNameoptionalStringDocumentTitleFieldNameoptionalstringDocumentTitleFieldNameoptional*string#The name of the field in the custom knowledge article that contains the document title.
fieldMappingsoptionalIResolvable | IResolvable | CfnDataSource.DataSourceToIndexFieldMappingProperty[]field_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceToIndexFieldMappingProperty]]]fieldMappingsoptionalIResolvableFieldMappingsoptionalIResolvableFieldMappingsoptionalinterface{}#Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.
notes
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.
The name of the configuration.