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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

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"],
}

Provides configuration information for connecting to a Salesforce data source.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#chatter_feed_configurationTypes::SalesforceChatterFeedConfiguration

Specifies configuration information for Salesforce chatter feeds.


5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/aws-sdk-kendra/types.rb', line 5123

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_attachmentsBoolean

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

Returns:

  • (Boolean)

5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/aws-sdk-kendra/types.rb', line 5123

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_patternsArray<String>

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.

Returns:

  • (Array<String>)

5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/aws-sdk-kendra/types.rb', line 5123

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_patternsArray<String>

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.

Returns:

  • (Array<String>)

5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/aws-sdk-kendra/types.rb', line 5123

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_configurationTypes::SalesforceKnowledgeArticleConfiguration

Specifies configuration information for the knowlege 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.


5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/aws-sdk-kendra/types.rb', line 5123

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_arnString

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret 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.

Returns:

  • (String)

5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/aws-sdk-kendra/types.rb', line 5123

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_urlString

The instance URL for the Salesforce site that you want to index.

Returns:

  • (String)

5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/aws-sdk-kendra/types.rb', line 5123

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_configurationTypes::SalesforceStandardObjectAttachmentConfiguration

Provides configuration information for processing attachments to Salesforce standard objects.


5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/aws-sdk-kendra/types.rb', line 5123

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_configurationsArray<Types::SalesforceStandardObjectConfiguration>

Specifies the Salesforce standard objects that Amazon Kendra indexes.


5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/aws-sdk-kendra/types.rb', line 5123

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