AWS::Kendra::DataSource ServiceNowServiceCatalogConfiguration - AWS CloudFormation

AWS::Kendra::DataSource ServiceNowServiceCatalogConfiguration

Provides 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, ... ] }

Properties

CrawlAttachments

Indicates whether Amazon Kendra should crawl attachments to the 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

Pattern: ^[a-zA-Z][a-zA-Z0-9_.]*$

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

Pattern: ^[a-zA-Z][a-zA-Z0-9_.]*$

Update requires: No interruption

ExcludeAttachmentFilePatterns

A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

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

Required: No

Type: List of String

Maximum: 100

Update requires: No interruption

FieldMappings

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

Required: No

Type: List of DataSourceToIndexFieldMapping

Maximum: 100

Update requires: No interruption

IncludeAttachmentFilePatterns

A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

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

Required: No

Type: List of String

Maximum: 100

Update requires: No interruption