interface SalesforceStandardObjectConfigurationProperty

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

Specifies configuration information for indexing a single standard object.

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 salesforceStandardObjectConfigurationProperty: kendra.CfnDataSource.SalesforceStandardObjectConfigurationProperty = {
  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 standard object table that contains the document contents.
name	string	The name of the standard object.
documentTitleFieldName?	string	The name of the field in the standard object table that contains the document title.
fieldMappings?	IResolvable | IResolvable | DataSourceToIndexFieldMappingProperty[]	Maps attributes or field names of the standard object to Amazon Kendra index field names.

---

documentDataFieldName

Type: string

The name of the field in the standard object table that contains the document contents.

---

name

Type: string

The name of the standard object.

---

documentTitleFieldName?

Type: string (optional)

The name of the field in the standard object table that contains the document title.

---

fieldMappings?

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

Maps attributes or field names of the standard object 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.