Class: Aws::Kendra::Types::SalesforceConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::SalesforceConfiguration
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
Provides the configuration information to connect to Salesforce as your data source.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#chatter_feed_configuration ⇒ Types::SalesforceChatterFeedConfiguration
Configuration information for Salesforce chatter feeds.
-
#crawl_attachments ⇒ Boolean
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
-
#exclude_attachment_file_patterns ⇒ Array<String>
A list of regular expression patterns to exclude certain documents in your Salesforce.
-
#include_attachment_file_patterns ⇒ Array<String>
A list of regular expression patterns to include certain documents in your Salesforce.
-
#knowledge_article_configuration ⇒ Types::SalesforceKnowledgeArticleConfiguration
Configuration information for the knowledge article types that Amazon Kendra indexes.
-
#secret_arn ⇒ String
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance.
-
#server_url ⇒ String
The instance URL for the Salesforce site that you want to index.
-
#standard_object_attachment_configuration ⇒ Types::SalesforceStandardObjectAttachmentConfiguration
Configuration information for processing attachments to Salesforce standard objects.
-
#standard_object_configurations ⇒ Array<Types::SalesforceStandardObjectConfiguration>
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
Instance Attribute Details
#chatter_feed_configuration ⇒ Types::SalesforceChatterFeedConfiguration
Configuration information for Salesforce chatter feeds.
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8927 class SalesforceConfiguration < Struct.new( :server_url, :secret_arn, :standard_object_configurations, :knowledge_article_configuration, :chatter_feed_configuration, :crawl_attachments, :standard_object_attachment_configuration, :include_attachment_file_patterns, :exclude_attachment_file_patterns) SENSITIVE = [] include Aws::Structure end |
#crawl_attachments ⇒ Boolean
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8927 class SalesforceConfiguration < Struct.new( :server_url, :secret_arn, :standard_object_configurations, :knowledge_article_configuration, :chatter_feed_configuration, :crawl_attachments, :standard_object_attachment_configuration, :include_attachment_file_patterns, :exclude_attachment_file_patterns) SENSITIVE = [] include Aws::Structure end |
#exclude_attachment_file_patterns ⇒ Array<String>
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.
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8927 class SalesforceConfiguration < Struct.new( :server_url, :secret_arn, :standard_object_configurations, :knowledge_article_configuration, :chatter_feed_configuration, :crawl_attachments, :standard_object_attachment_configuration, :include_attachment_file_patterns, :exclude_attachment_file_patterns) SENSITIVE = [] include Aws::Structure end |
#include_attachment_file_patterns ⇒ Array<String>
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.
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8927 class SalesforceConfiguration < Struct.new( :server_url, :secret_arn, :standard_object_configurations, :knowledge_article_configuration, :chatter_feed_configuration, :crawl_attachments, :standard_object_attachment_configuration, :include_attachment_file_patterns, :exclude_attachment_file_patterns) SENSITIVE = [] include Aws::Structure end |
#knowledge_article_configuration ⇒ Types::SalesforceKnowledgeArticleConfiguration
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.
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8927 class SalesforceConfiguration < Struct.new( :server_url, :secret_arn, :standard_object_configurations, :knowledge_article_configuration, :chatter_feed_configuration, :crawl_attachments, :standard_object_attachment_configuration, :include_attachment_file_patterns, :exclude_attachment_file_patterns) SENSITIVE = [] include Aws::Structure end |
#secret_arn ⇒ String
The Amazon Resource Name (ARN) of an 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.
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8927 class SalesforceConfiguration < Struct.new( :server_url, :secret_arn, :standard_object_configurations, :knowledge_article_configuration, :chatter_feed_configuration, :crawl_attachments, :standard_object_attachment_configuration, :include_attachment_file_patterns, :exclude_attachment_file_patterns) SENSITIVE = [] include Aws::Structure end |
#server_url ⇒ String
The instance URL for the Salesforce site that you want to index.
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8927 class SalesforceConfiguration < Struct.new( :server_url, :secret_arn, :standard_object_configurations, :knowledge_article_configuration, :chatter_feed_configuration, :crawl_attachments, :standard_object_attachment_configuration, :include_attachment_file_patterns, :exclude_attachment_file_patterns) SENSITIVE = [] include Aws::Structure end |
#standard_object_attachment_configuration ⇒ Types::SalesforceStandardObjectAttachmentConfiguration
Configuration information for processing attachments to Salesforce standard objects.
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8927 class SalesforceConfiguration < Struct.new( :server_url, :secret_arn, :standard_object_configurations, :knowledge_article_configuration, :chatter_feed_configuration, :crawl_attachments, :standard_object_attachment_configuration, :include_attachment_file_patterns, :exclude_attachment_file_patterns) SENSITIVE = [] include Aws::Structure end |
#standard_object_configurations ⇒ Array<Types::SalesforceStandardObjectConfiguration>
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8927 class SalesforceConfiguration < Struct.new( :server_url, :secret_arn, :standard_object_configurations, :knowledge_article_configuration, :chatter_feed_configuration, :crawl_attachments, :standard_object_attachment_configuration, :include_attachment_file_patterns, :exclude_attachment_file_patterns) SENSITIVE = [] include Aws::Structure end |