This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Kendra::DataSource SalesforceConfiguration
Provides the configuration information to connect to Salesforce as your data source.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ChatterFeedConfiguration" :SalesforceChatterFeedConfiguration, "CrawlAttachments" :Boolean, "ExcludeAttachmentFilePatterns" :[ String, ... ], "IncludeAttachmentFilePatterns" :[ String, ... ], "KnowledgeArticleConfiguration" :SalesforceKnowledgeArticleConfiguration, "SecretArn" :String, "ServerUrl" :String, "StandardObjectAttachmentConfiguration" :SalesforceStandardObjectAttachmentConfiguration, "StandardObjectConfigurations" :[ SalesforceStandardObjectConfiguration, ... ]}
YAML
ChatterFeedConfiguration:SalesforceChatterFeedConfigurationCrawlAttachments:BooleanExcludeAttachmentFilePatterns:- StringIncludeAttachmentFilePatterns:- StringKnowledgeArticleConfiguration:SalesforceKnowledgeArticleConfigurationSecretArn:StringServerUrl:StringStandardObjectAttachmentConfiguration:SalesforceStandardObjectAttachmentConfigurationStandardObjectConfigurations:- SalesforceStandardObjectConfiguration
Properties
ChatterFeedConfiguration-
Configuration information for Salesforce chatter feeds.
Required: No
Type: SalesforceChatterFeedConfiguration
Update requires: No interruption
CrawlAttachments-
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
Required: No
Type: Boolean
Update requires: No interruption
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.
Required: No
Type: Array of String
Minimum:
1Maximum:
50 | 100Update requires: No interruption
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.
Required: No
Type: Array of String
Minimum:
1Maximum:
50 | 100Update requires: No interruption
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.
Required: No
Type: SalesforceKnowledgeArticleConfiguration
Update requires: No interruption
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.
Required: Yes
Type: String
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Minimum:
1Maximum:
1284Update requires: No interruption
-
ServerUrl-
The instance URL for the Salesforce site that you want to index.
Required: Yes
Type: String
Pattern:
^(https?|ftp|file)://([^\s]*)Minimum:
1Maximum:
2048Update requires: No interruption
StandardObjectAttachmentConfiguration-
Configuration information for processing attachments to Salesforce standard objects.
Required: No
Type: SalesforceStandardObjectAttachmentConfiguration
Update requires: No interruption
StandardObjectConfigurations-
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
Required: No
Type: Array of SalesforceStandardObjectConfiguration
Minimum:
1Maximum:
17Update requires: No interruption
