software.amazon.awscdk.services.kendra

Interface CfnDataSource.SalesforceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.SalesforceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.SalesforceConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Provides the configuration information to connect to Salesforce as your data source.

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.*;
 SalesforceConfigurationProperty salesforceConfigurationProperty = SalesforceConfigurationProperty.builder()
         .secretArn("secretArn")
         .serverUrl("serverUrl")
         // the properties below are optional
         .chatterFeedConfiguration(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())
         .crawlAttachments(false)
         .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
         .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
         .knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfigurationProperty.builder()
                 .includedStates(List.of("includedStates"))
                 // the properties below are optional
                 .customKnowledgeArticleTypeConfigurations(List.of(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()))
                 .standardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfigurationProperty.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()))
                         .build())
                 .build())
         .standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfigurationProperty.builder()
                 .documentTitleFieldName("documentTitleFieldName")
                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                         .dataSourceFieldName("dataSourceFieldName")
                         .indexFieldName("indexFieldName")
                         // the properties below are optional
                         .dateFieldFormat("dateFieldFormat")
                         .build()))
                 .build())
         .standardObjectConfigurations(List.of(SalesforceStandardObjectConfigurationProperty.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()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.SalesforceConfigurationProperty.Builder	builder()
default Object	getChatterFeedConfiguration() Configuration information for Salesforce chatter feeds.
default Object	getCrawlAttachments() Indicates whether Amazon Kendra should index attachments to Salesforce objects.
default List<String>	getExcludeAttachmentFilePatterns() A list of regular expression patterns to exclude certain documents in your Salesforce.
default List<String>	getIncludeAttachmentFilePatterns() A list of regular expression patterns to include certain documents in your Salesforce.
default Object	getKnowledgeArticleConfiguration() Configuration information for the knowledge article types that Amazon Kendra indexes.
String	getSecretArn() The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance.
String	getServerUrl() The instance URL for the Salesforce site that you want to index.
default Object	getStandardObjectAttachmentConfiguration() Configuration information for processing attachments to Salesforce standard objects.
default Object	getStandardObjectConfigurations() Configuration of the Salesforce standard objects that Amazon Kendra indexes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSecretArn

@Stability(value=Stable)
 @NotNull
String getSecretArn()

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance.

The secret must contain a JSON structure with the following keys:

• authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
• consumerKey - The application public key generated when you created your Salesforce application.
• consumerSecret - The application private key generated when you created your Salesforce application.
• password - The password associated with the user logging in to the Salesforce instance.
• securityToken - The token associated with the user account logging in to the Salesforce instance.
• username - The user name of the user logging in to the Salesforce instance.

getServerUrl

@Stability(value=Stable)
 @NotNull
String getServerUrl()

The instance URL for the Salesforce site that you want to index.

getChatterFeedConfiguration

@Stability(value=Stable)
 @Nullable
default Object getChatterFeedConfiguration()

Configuration information for Salesforce chatter feeds.

getCrawlAttachments

@Stability(value=Stable)
 @Nullable
default Object getCrawlAttachments()

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

getExcludeAttachmentFilePatterns

@Stability(value=Stable)
 @Nullable
default List<String> getExcludeAttachmentFilePatterns()

A list of regular expression patterns to exclude certain documents in your Salesforce.

Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

getIncludeAttachmentFilePatterns

@Stability(value=Stable)
 @Nullable
default List<String> getIncludeAttachmentFilePatterns()

A list of regular expression patterns to include certain documents in your Salesforce.

Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

getKnowledgeArticleConfiguration

@Stability(value=Stable)
 @Nullable
default Object getKnowledgeArticleConfiguration()

Configuration information for the knowledge article types that Amazon Kendra indexes.

Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

getStandardObjectAttachmentConfiguration

@Stability(value=Stable)
 @Nullable
default Object getStandardObjectAttachmentConfiguration()

Configuration information for processing attachments to Salesforce standard objects.

getStandardObjectConfigurations

@Stability(value=Stable)
 @Nullable
default Object getStandardObjectConfigurations()

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

builder

@Stability(value=Stable)
static CfnDataSource.SalesforceConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.SalesforceConfigurationProperty.Builder of CfnDataSource.SalesforceConfigurationProperty