Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnDataSource
@Stability(Stable) public static interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty extends software.amazon.jsii.JsiiSerializable
Provides the configuration information for crawling knowledge articles 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.*;
 ServiceNowKnowledgeArticleConfigurationProperty serviceNowKnowledgeArticleConfigurationProperty = ServiceNowKnowledgeArticleConfigurationProperty.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()))
         .filterQuery("filterQuery")
         .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
         .build();

  • Method Details

    • getDocumentDataFieldName

      @Stability(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(Stable) @Nullable default Object getCrawlAttachments()
      TRUE to index attachments to knowledge articles.

    • getDocumentTitleFieldName

      @Stability(Stable) @Nullable default String getDocumentTitleFieldName()
      The name of the ServiceNow field that is mapped to the index document title field.

    • getExcludeAttachmentFilePatterns

      @Stability(Stable) @Nullable default List<String> getExcludeAttachmentFilePatterns()
      A list of regular expression patterns applied to exclude certain knowledge article attachments.

      Attachments 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.

    • getFieldMappings

      @Stability(Stable) @Nullable default Object getFieldMappings()
      Maps attributes or field names of knoweldge articles 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.

    • getFilterQuery

      @Stability(Stable) @Nullable default String getFilterQuery()
      A query that selects the knowledge articles to index.

      The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

      The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .

    • getIncludeAttachmentFilePatterns

      @Stability(Stable) @Nullable default List<String> getIncludeAttachmentFilePatterns()
      A list of regular expression patterns applied to include knowledge article attachments.

      Attachments 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.

    • builder

      @Stability(Stable) static CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder builder()
      Returns:
      a CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder of CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty