class Aws::Kendra::Types::SalesforceConfiguration
Provides configuration information for connecting to a Salesforce data source.
@note When making an API call, you may pass SalesforceConfiguration
data as a hash: { server_url: "Url", # required secret_arn: "SecretArn", # required standard_object_configurations: [ { name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER document_data_field_name: "DataSourceFieldName", # required document_title_field_name: "DataSourceFieldName", field_mappings: [ { data_source_field_name: "DataSourceFieldName", # required date_field_format: "DataSourceDateFieldFormat", index_field_name: "IndexFieldName", # required }, ], }, ], knowledge_article_configuration: { included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED standard_knowledge_article_type_configuration: { document_data_field_name: "DataSourceFieldName", # required document_title_field_name: "DataSourceFieldName", field_mappings: [ { data_source_field_name: "DataSourceFieldName", # required date_field_format: "DataSourceDateFieldFormat", index_field_name: "IndexFieldName", # required }, ], }, custom_knowledge_article_type_configurations: [ { name: "SalesforceCustomKnowledgeArticleTypeName", # required document_data_field_name: "DataSourceFieldName", # required document_title_field_name: "DataSourceFieldName", field_mappings: [ { data_source_field_name: "DataSourceFieldName", # required date_field_format: "DataSourceDateFieldFormat", index_field_name: "IndexFieldName", # required }, ], }, ], }, chatter_feed_configuration: { document_data_field_name: "DataSourceFieldName", # required document_title_field_name: "DataSourceFieldName", field_mappings: [ { data_source_field_name: "DataSourceFieldName", # required date_field_format: "DataSourceDateFieldFormat", index_field_name: "IndexFieldName", # required }, ], include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER }, crawl_attachments: false, standard_object_attachment_configuration: { document_title_field_name: "DataSourceFieldName", field_mappings: [ { data_source_field_name: "DataSourceFieldName", # required date_field_format: "DataSourceDateFieldFormat", index_field_name: "IndexFieldName", # required }, ], }, include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"], exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"], }
@!attribute [rw] server_url
The instance URL for the Salesforce site that you want to index. @return [String]
@!attribute [rw] secret_arn
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 account logging in to the Salesforce instance. * username - The user name of the user logging in to the Salesforce instance. @return [String]
@!attribute [rw] standard_object_configurations
Specifies the Salesforce standard objects that Amazon Kendra indexes. @return [Array<Types::SalesforceStandardObjectConfiguration>]
@!attribute [rw] knowledge_article_configuration
Specifies 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. @return [Types::SalesforceKnowledgeArticleConfiguration]
@!attribute [rw] chatter_feed_configuration
Specifies configuration information for Salesforce chatter feeds. @return [Types::SalesforceChatterFeedConfiguration]
@!attribute [rw] crawl_attachments
Indicates whether Amazon Kendra should index attachments to Salesforce objects. @return [Boolean]
@!attribute [rw] standard_object_attachment_configuration
Provides configuration information for processing attachments to Salesforce standard objects. @return [Types::SalesforceStandardObjectAttachmentConfiguration]
@!attribute [rw] include_attachment_file_patterns
A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index. The regex is applied to the name of the attached file. @return [Array<String>]
@!attribute [rw] exclude_attachment_file_patterns
A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index. The regex is applied to the name of the attached file. @return [Array<String>]
@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceConfiguration AWS API Documentation
Constants
- SENSITIVE