AWS::Kendra::DataSource ServiceNowServiceCatalogConfiguration

Provides the configuration information for crawling service catalog items 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, ... ],
  "IncludeAttachmentFilePatterns" : [ String, ... ]
}

YAML

  CrawlAttachments: Boolean
  DocumentDataFieldName: String
  DocumentTitleFieldName: String
  ExcludeAttachmentFilePatterns: 
    - String
  FieldMappings: 
    - DataSourceToIndexFieldMapping
  IncludeAttachmentFilePatterns: 
    - String

Properties

CrawlAttachments

TRUE to index attachments to service catalog items.

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 to exclude certain attachments of catalogs in your ServiceNow. Item 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.

The regex is applied to the file name of the attachment.

Required: No

Type: Array of String

Minimum: 1

Maximum: 50 | 100

Update requires: No interruption

FieldMappings

Maps attributes or field names of catalogs 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

IncludeAttachmentFilePatterns

A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item 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.

The regex is applied to the file name of the attachment.

Required: No

Type: Array of String

Minimum: 1

Maximum: 50 | 100

Update requires: No interruption