Class: Aws::Kendra::Types::SalesforceConfiguration

Inherits:
Struct
  • Object
show all
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#chatter_feed_configuration ⇒ Types::SalesforceChatterFeedConfiguration

Configuration information for Salesforce chatter feeds.

Returns:



8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8981

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.

Returns:

  • (Boolean) 


8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8981

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.

Returns:

  • (Array<String>) 


8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8981

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.

Returns:

  • (Array<String>) 


8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8981

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.

Returns:



8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8981

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.

Returns:

  • (String) 


8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8981

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.

Returns:

  • (String) 


8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8981

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.

Returns:



8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8981

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.

Returns:



8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8981

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