Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.SalesforceChatterFeedConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.SalesforceChatterFeedConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

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

The configuration information for syncing a Salesforce chatter feed.

The contents of the object comes from the Salesforce FeedItem table.

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.*;
 SalesforceChatterFeedConfigurationProperty salesforceChatterFeedConfigurationProperty = SalesforceChatterFeedConfigurationProperty.builder()
         .documentDataFieldName("documentDataFieldName")
         // the properties below are optional
         .documentTitleFieldName("documentTitleFieldName")
         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .indexFieldName("indexFieldName")
                 // the properties below are optional
                 .dateFieldFormat("dateFieldFormat")
                 .build()))
         .includeFilterTypes(List.of("includeFilterTypes"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.SalesforceChatterFeedConfigurationProperty.Builder	builder()
String	getDocumentDataFieldName()	The name of the column in the Salesforce FeedItem table that contains the content to index.
default String	getDocumentTitleFieldName()	The name of the column in the Salesforce FeedItem table that contains the title of the document.
default Object	getFieldMappings()	Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
default List<String>	getIncludeFilterTypes()	Filters the documents in the feed based on status of the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDocumentDataFieldName

@Stability(Stable)
@NotNull
String getDocumentDataFieldName()

The name of the column in the Salesforce FeedItem table that contains the content to index.

Typically this is the Body column.

getDocumentTitleFieldName

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

The name of the column in the Salesforce FeedItem table that contains the title of the document.

This is typically the Title column.

getFieldMappings

@Stability(Stable)
@Nullable
default Object getFieldMappings()

Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

getIncludeFilterTypes

@Stability(Stable)
@Nullable
default List<String> getIncludeFilterTypes()

Filters the documents in the feed based on status of the user.

When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

builder

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

Returns:

a CfnDataSource.SalesforceChatterFeedConfigurationProperty.Builder of CfnDataSource.SalesforceChatterFeedConfigurationProperty