Interface CfnDataSource.IServiceNowServiceCatalogConfigurationProperty
Provides the configuration information for crawling service catalog items in the ServiceNow site.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IServiceNowServiceCatalogConfigurationProperty
Syntax (vb)
Public Interface IServiceNowServiceCatalogConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var serviceNowServiceCatalogConfigurationProperty = new ServiceNowServiceCatalogConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
CrawlAttachments = false,
DocumentTitleFieldName = "documentTitleFieldName",
ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
};
Synopsis
Properties
CrawlAttachments |
|
DocumentDataFieldName | The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index. |
DocumentTitleFieldName | The name of the ServiceNow field that is mapped to the index document title field. |
ExcludeAttachmentFilePatterns | A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. |
FieldMappings | Maps attributes or field names of catalogs to Amazon Kendra index field names. |
IncludeAttachmentFilePatterns | A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. |
Properties
CrawlAttachments
TRUE
to index attachments to service catalog items.
virtual object CrawlAttachments { get; }
Property Value
System.Object
Remarks
DocumentDataFieldName
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
string DocumentDataFieldName { get; }
Property Value
System.String
Remarks
DocumentTitleFieldName
The name of the ServiceNow field that is mapped to the index document title field.
virtual string DocumentTitleFieldName { get; }
Property Value
System.String
Remarks
ExcludeAttachmentFilePatterns
A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow.
virtual string[] ExcludeAttachmentFilePatterns { get; }
Property Value
System.String[]
Remarks
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
Maps attributes or field names of catalogs to Amazon Kendra index field names.
virtual object FieldMappings { get; }
Property Value
System.Object
Remarks
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
A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow.
virtual string[] IncludeAttachmentFilePatterns { get; }
Property Value
System.String[]
Remarks
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.