1.204.0

interface ServiceNowServiceCatalogConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.ServiceNowServiceCatalogConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.ServiceNowServiceCatalogConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.ServiceNowServiceCatalogConfigurationProperty
TypeScript @aws-cdk/aws-kendra » CfnDataSource » ServiceNowServiceCatalogConfigurationProperty

Provides the configuration information for crawling service catalog items in the ServiceNow site.

Example

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

Properties

NameTypeDescription
documentDataFieldNamestringThe name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
crawlAttachments?boolean | IResolvableTRUE to index attachments to service catalog items.
documentTitleFieldName?stringThe name of the ServiceNow field that is mapped to the index document title field.
excludeAttachmentFilePatterns?string[]A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow.
fieldMappings?IResolvable | IResolvable | DataSourceToIndexFieldMappingProperty[]Maps attributes or field names of catalogs to Amazon Kendra index field names.
includeAttachmentFilePatterns?string[]A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow.

documentDataFieldName

Type: string

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

crawlAttachments?

Type: boolean | IResolvable (optional)

TRUE to index attachments to service catalog items.

documentTitleFieldName?

Type: string (optional)

The name of the ServiceNow field that is mapped to the index document title field.

excludeAttachmentFilePatterns?

Type: string[] (optional)

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.

fieldMappings?

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

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.

includeAttachmentFilePatterns?

Type: string[] (optional)

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.

← PreviousNext →