interface SalesforceConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnDataSource.SalesforceConfigurationProperty`
Java	`software.amazon.awscdk.services.kendra.CfnDataSource.SalesforceConfigurationProperty`
Python	`aws_cdk.aws_kendra.CfnDataSource.SalesforceConfigurationProperty`
TypeScript	`@aws-cdk/aws-kendra` » `CfnDataSource` » `SalesforceConfigurationProperty`

Provides the configuration information to connect to Salesforce as your data source.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kendra from '@aws-cdk/aws-kendra';
const salesforceConfigurationProperty: kendra.CfnDataSource.SalesforceConfigurationProperty = {
  secretArn: 'secretArn',
  serverUrl: 'serverUrl',

  // the properties below are optional
  chatterFeedConfiguration: {
    documentDataFieldName: 'documentDataFieldName',

    // the properties below are optional
    documentTitleFieldName: 'documentTitleFieldName',
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
    includeFilterTypes: ['includeFilterTypes'],
  },
  crawlAttachments: false,
  excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
  includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
  knowledgeArticleConfiguration: {
    includedStates: ['includedStates'],

    // the properties below are optional
    customKnowledgeArticleTypeConfigurations: [{
      documentDataFieldName: 'documentDataFieldName',
      name: 'name',

      // the properties below are optional
      documentTitleFieldName: 'documentTitleFieldName',
      fieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        indexFieldName: 'indexFieldName',

        // the properties below are optional
        dateFieldFormat: 'dateFieldFormat',
      }],
    }],
    standardKnowledgeArticleTypeConfiguration: {
      documentDataFieldName: 'documentDataFieldName',

      // the properties below are optional
      documentTitleFieldName: 'documentTitleFieldName',
      fieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        indexFieldName: 'indexFieldName',

        // the properties below are optional
        dateFieldFormat: 'dateFieldFormat',
      }],
    },
  },
  standardObjectAttachmentConfiguration: {
    documentTitleFieldName: 'documentTitleFieldName',
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
  },
  standardObjectConfigurations: [{
    documentDataFieldName: 'documentDataFieldName',
    name: 'name',

    // the properties below are optional
    documentTitleFieldName: 'documentTitleFieldName',
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
  }],
};

Properties

Name	Type	Description
secretArn	`string`	The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance.
serverUrl	`string`	The instance URL for the Salesforce site that you want to index.
chatterFeedConfiguration?	`IResolvable` `\|` `SalesforceChatterFeedConfigurationProperty`	Configuration information for Salesforce chatter feeds.
crawlAttachments?	`boolean \|` `IResolvable`	Indicates whether Amazon Kendra should index attachments to Salesforce objects.
excludeAttachmentFilePatterns?	`string[]`	A list of regular expression patterns to exclude certain documents in your Salesforce.
includeAttachmentFilePatterns?	`string[]`	A list of regular expression patterns to include certain documents in your Salesforce.
knowledgeArticleConfiguration?	`IResolvable` `\|` `SalesforceKnowledgeArticleConfigurationProperty`	Configuration information for the knowledge article types that Amazon Kendra indexes.
standardObjectAttachmentConfiguration?	`IResolvable` `\|` `SalesforceStandardObjectAttachmentConfigurationProperty`	Configuration information for processing attachments to Salesforce standard objects.
standardObjectConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `SalesforceStandardObjectConfigurationProperty[]`	Configuration of the Salesforce standard objects that Amazon Kendra indexes.

secretArn

Type: string

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 logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

serverUrl

Type: string

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

chatterFeedConfiguration?

Type: IResolvable | SalesforceChatterFeedConfigurationProperty (optional)

Configuration information for Salesforce chatter feeds.

crawlAttachments?

Type: boolean | IResolvable (optional)

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

excludeAttachmentFilePatterns?

Type: string[] (optional)

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.

includeAttachmentFilePatterns?

Type: string[] (optional)

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.

knowledgeArticleConfiguration?

Type: IResolvable | SalesforceKnowledgeArticleConfigurationProperty (optional)

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.

standardObjectAttachmentConfiguration?

Type: IResolvable | SalesforceStandardObjectAttachmentConfigurationProperty (optional)

Configuration information for processing attachments to Salesforce standard objects.

standardObjectConfigurations?

Type: IResolvable | IResolvable | SalesforceStandardObjectConfigurationProperty[] (optional)

Configuration of the Salesforce standard objects that Amazon Kendra indexes.