AWS CDK Reference

Appearance

v2.275.0

ServiceNowKnowledgeArticleConfigurationProperty Struct ​

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// 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 serviceNowKnowledgeArticleConfigurationProperty: kendra.CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty = {
  documentDataFieldName: 'documentDataFieldName',

  // the properties below are optional
  crawlAttachments: false,
  documentTitleFieldName: 'documentTitleFieldName',
  excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
  fieldMappings: [{
    dataSourceFieldName: 'dataSourceFieldName',
    indexFieldName: 'indexFieldName',

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

Properties ​

crawlAttachmentsoptionalboolean | IResolvablecrawl_attachmentsoptionaltyping.Union[bool, IResolvable]crawlAttachmentsoptionalBooleanCrawlAttachmentsoptionalboolCrawlAttachmentsoptionalinterface{}#
`TRUE` to index attachments to knowledge articles.
documentDataFieldNamestringdocument_data_field_namestrdocumentDataFieldNameStringDocumentDataFieldNamestringDocumentDataFieldName*stringrequired#
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
documentTitleFieldNameoptionalstringdocument_title_field_nameoptionalstrdocumentTitleFieldNameoptionalStringDocumentTitleFieldNameoptionalstringDocumentTitleFieldNameoptional*string#
The name of the ServiceNow field that is mapped to the index document title field.
excludeAttachmentFilePatternsoptionalstring[]exclude_attachment_file_patternsoptionaltyping.List[str]excludeAttachmentFilePatternsoptionalList<String>ExcludeAttachmentFilePatternsoptionalstring[]ExcludeAttachmentFilePatternsoptional*[]*string#
A list of regular expression patterns applied to exclude certain knowledge article attachments.
notes

Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

fieldMappingsoptionalIResolvable | IResolvable | CfnDataSource.DataSourceToIndexFieldMappingProperty[]field_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceToIndexFieldMappingProperty]]]fieldMappingsoptionalIResolvableFieldMappingsoptionalIResolvableFieldMappingsoptionalinterface{}#
Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
notes

To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields . The ServiceNow data source field names must exist in your ServiceNow custom metadata.

filterQueryoptionalstringfilter_queryoptionalstrfilterQueryoptionalStringFilterQueryoptionalstringFilterQueryoptional*string#
A query that selects the knowledge articles to index.
notes

The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .

includeAttachmentFilePatternsoptionalstring[]include_attachment_file_patternsoptionaltyping.List[str]includeAttachmentFilePatternsoptionalList<String>IncludeAttachmentFilePatternsoptionalstring[]IncludeAttachmentFilePatternsoptional*[]*string#
A list of regular expression patterns applied to include knowledge article attachments.
notes

Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.