software.amazon.awscdk.services.kendra

Interface CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty

All Known Implementing Classes:

CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

public static interface 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 software.amazon.awscdk.services.kendra.*;
 SalesforceCustomKnowledgeArticleTypeConfigurationProperty salesforceCustomKnowledgeArticleTypeConfigurationProperty = SalesforceCustomKnowledgeArticleTypeConfigurationProperty.builder()
         .documentDataFieldName("documentDataFieldName")
         .name("name")
         // the properties below are optional
         .documentTitleFieldName("documentTitleFieldName")
         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .indexFieldName("indexFieldName")
                 // the properties below are optional
                 .dateFieldFormat("dateFieldFormat")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Builder A builder for CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty
static class	CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Builder	builder()
java.lang.String	getDocumentDataFieldName() The name of the field in the custom knowledge article that contains the document data to index.
default java.lang.String	getDocumentTitleFieldName() The name of the field in the custom knowledge article that contains the document title.
default java.lang.Object	getFieldMappings() Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.
java.lang.String	getName() The name of the configuration.

Method Detail

getDocumentDataFieldName

java.lang.String getDocumentDataFieldName()

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

getName

java.lang.String getName()

The name of the configuration.

getDocumentTitleFieldName

default java.lang.String getDocumentTitleFieldName()

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

getFieldMappings

default java.lang.Object getFieldMappings()

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.

builder

static CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Builder of CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty