AWS::Kendra::DataSource ServiceNowKnowledgeArticleConfiguration
Provides the configuration information for crawling knowledge articles in the ServiceNow site.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CrawlAttachments" :
Boolean
, "DocumentDataFieldName" :String
, "DocumentTitleFieldName" :String
, "ExcludeAttachmentFilePatterns" :[ String, ... ]
, "FieldMappings" :[ DataSourceToIndexFieldMapping, ... ]
, "FilterQuery" :String
, "IncludeAttachmentFilePatterns" :[ String, ... ]
}
YAML
CrawlAttachments:
Boolean
DocumentDataFieldName:String
DocumentTitleFieldName:String
ExcludeAttachmentFilePatterns:- String
FieldMappings:- DataSourceToIndexFieldMapping
FilterQuery:String
IncludeAttachmentFilePatterns:- String
Properties
CrawlAttachments
-
TRUE
to index attachments to knowledge articles.Required: No
Type: Boolean
Update requires: No interruption
DocumentDataFieldName
-
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
Required: Yes
Type: String
Minimum:
1
Maximum:
100
Update requires: No interruption
DocumentTitleFieldName
-
The name of the ServiceNow field that is mapped to the index document title field.
Required: No
Type: String
Minimum:
1
Maximum:
100
Update requires: No interruption
ExcludeAttachmentFilePatterns
-
A list of regular expression patterns applied to exclude certain knowledge article attachments. 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.
Required: No
Type: Array of String
Minimum:
1
Maximum:
50 | 100
Update requires: No interruption
FieldMappings
-
Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. 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.Required: No
Type: Array of DataSourceToIndexFieldMapping
Maximum:
100
Update requires: No interruption
FilterQuery
-
A query that selects the knowledge articles to index. 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.
Required: No
Type: String
Minimum:
1
Maximum:
2048
Update requires: No interruption
IncludeAttachmentFilePatterns
-
A list of regular expression patterns applied to include knowledge article attachments. 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.
Required: No
Type: Array of String
Minimum:
1
Maximum:
50 | 100
Update requires: No interruption