interface SalesforceCustomKnowledgeArticleTypeConfigurationProperty

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty`
Java	`software.amazon.awscdk.services.kendra.CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty`
Python	`aws_cdk.aws_kendra.CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty`
TypeScript	`@aws-cdk/aws-kendra` » `CfnDataSource` » `SalesforceCustomKnowledgeArticleTypeConfigurationProperty`

Provides the configuration information for indexing Salesforce custom articles.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kendra from '@aws-cdk/aws-kendra';
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

Name	Type	Description
documentDataFieldName	`string`	The name of the field in the custom knowledge article that contains the document data to index.
name	`string`	The name of the configuration.
documentTitleFieldName?	`string`	The name of the field in the custom knowledge article that contains the document title.
fieldMappings?	`IResolvable` `\|` `IResolvable` `\|` `DataSourceToIndexFieldMappingProperty[]`	Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.

documentDataFieldName

Type: string

The name of the field in the custom knowledge article that contains the document data to index.

name

Type: string

The name of the configuration.

documentTitleFieldName?

Type: string (optional)

The name of the field in the custom knowledge article that contains the document title.

fieldMappings?

Type: IResolvable | IResolvable | DataSourceToIndexFieldMappingProperty[] (optional)

Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.

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.