software.amazon.awscdk.services.kendra

Interface CfnDataSource.ServiceNowServiceCatalogConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.ServiceNowServiceCatalogConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Provides 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 software.amazon.awscdk.services.kendra.*;
 ServiceNowServiceCatalogConfigurationProperty serviceNowServiceCatalogConfigurationProperty = ServiceNowServiceCatalogConfigurationProperty.builder()
         .documentDataFieldName("documentDataFieldName")
         // the properties below are optional
         .crawlAttachments(false)
         .documentTitleFieldName("documentTitleFieldName")
         .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .indexFieldName("indexFieldName")
                 // the properties below are optional
                 .dateFieldFormat("dateFieldFormat")
                 .build()))
         .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder A builder for CfnDataSource.ServiceNowServiceCatalogConfigurationProperty
static class	CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.ServiceNowServiceCatalogConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder	builder()
default Object	getCrawlAttachments() Indicates whether Amazon Kendra should crawl attachments to the service catalog items.
String	getDocumentDataFieldName() The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
default String	getDocumentTitleFieldName() The name of the ServiceNow field that is mapped to the index document title field.
default List<String>	getExcludeAttachmentFilePatterns() A list of regular expression patterns.
default Object	getFieldMappings() Mapping between ServiceNow fields and Amazon Kendra index fields.
default List<String>	getIncludeAttachmentFilePatterns() A list of regular expression patterns.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDocumentDataFieldName

@Stability(value=Stable)
 @NotNull
String getDocumentDataFieldName()

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

getCrawlAttachments

@Stability(value=Stable)
 @Nullable
default Object getCrawlAttachments()

Indicates whether Amazon Kendra should crawl attachments to the service catalog items.

getDocumentTitleFieldName

@Stability(value=Stable)
 @Nullable
default String getDocumentTitleFieldName()

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

getExcludeAttachmentFilePatterns

@Stability(value=Stable)
 @Nullable
default List<String> getExcludeAttachmentFilePatterns()

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.

getFieldMappings

@Stability(value=Stable)
 @Nullable
default Object getFieldMappings()

Mapping between ServiceNow fields and Amazon Kendra index fields.

You must create the index field before you map the field.

getIncludeAttachmentFilePatterns

@Stability(value=Stable)
 @Nullable
default List<String> getIncludeAttachmentFilePatterns()

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.

builder

@Stability(value=Stable)
static CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder of CfnDataSource.ServiceNowServiceCatalogConfigurationProperty