aws-cdk-lib.aws_kendra.CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty

interface SalesforceKnowledgeArticleConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_SalesforceKnowledgeArticleConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty
TypeScript aws-cdk-lib » aws_kendra » CfnDataSource » SalesforceKnowledgeArticleConfigurationProperty

Provides the 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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const salesforceKnowledgeArticleConfigurationProperty: kendra.CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty = {
  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',
    }],
  },
};

Properties

NameTypeDescription
includedStatesstring[]Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
customKnowledgeArticleTypeConfigurations?IResolvable | IResolvable | SalesforceCustomKnowledgeArticleTypeConfigurationProperty[]Configuration information for custom Salesforce knowledge articles.
standardKnowledgeArticleTypeConfiguration?IResolvable | SalesforceStandardKnowledgeArticleTypeConfigurationPropertyConfiguration information for standard Salesforce knowledge articles.

includedStates

Type: string[]

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.

You must specify at least one state.


customKnowledgeArticleTypeConfigurations?

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

Configuration information for custom Salesforce knowledge articles.


standardKnowledgeArticleTypeConfiguration?

Type: IResolvable | SalesforceStandardKnowledgeArticleTypeConfigurationProperty (optional)

Configuration information for standard Salesforce knowledge articles.