Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Builder	A builder for CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty
static final class	CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Jsii$Proxy	An implementation for CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDocumentDataFieldName

@Stability(Stable)
@NotNull
String getDocumentDataFieldName()

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the configuration.

getDocumentTitleFieldName

@Stability(Stable)
@Nullable
default String getDocumentTitleFieldName()

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

getFieldMappings

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
static CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Builder of CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty