SalesforceConfiguration
Provides the configuration information to connect to Salesforce as your data source.
Contents
- SecretArn
-
The Amazon Resource Name (ARN) of an AWS Secrets Managersecret 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 logging in to the Salesforce instance.
-
username - The user name of the user logging in to the Salesforce instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1284.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: Yes
-
- ServerUrl
-
The instance URL for the Salesforce site that you want to index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(https?|ftp|file):\/\/([^\s]*)Required: Yes
- ChatterFeedConfiguration
-
Configuration information for Salesforce chatter feeds.
Type: SalesforceChatterFeedConfiguration object
Required: No
- CrawlAttachments
-
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
Type: Boolean
Required: No
- ExcludeAttachmentFilePatterns
-
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.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- IncludeAttachmentFilePatterns
-
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.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- KnowledgeArticleConfiguration
-
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.
Type: SalesforceKnowledgeArticleConfiguration object
Required: No
- StandardObjectAttachmentConfiguration
-
Configuration information for processing attachments to Salesforce standard objects.
Type: SalesforceStandardObjectAttachmentConfiguration object
Required: No
- StandardObjectConfigurations
-
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
Type: Array of SalesforceStandardObjectConfiguration objects
Array Members: Minimum number of 1 item. Maximum number of 17 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
