Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.ConfluenceSpaceConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDataSource.ConfluenceSpaceConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnDataSource
@Stability(Stable) public static interface CfnDataSource.ConfluenceSpaceConfigurationProperty extends software.amazon.jsii.JsiiSerializable
Configuration information for indexing Confluence spaces.

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.*;
 ConfluenceSpaceConfigurationProperty confluenceSpaceConfigurationProperty = ConfluenceSpaceConfigurationProperty.builder()
         .crawlArchivedSpaces(false)
         .crawlPersonalSpaces(false)
         .excludeSpaces(List.of("excludeSpaces"))
         .includeSpaces(List.of("includeSpaces"))
         .spaceFieldMappings(List.of(ConfluenceSpaceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .indexFieldName("indexFieldName")
                 // the properties below are optional
                 .dateFieldFormat("dateFieldFormat")
                 .build()))
         .build();

  • Method Details

    • getCrawlArchivedSpaces

      @Stability(Stable) @Nullable default Object getCrawlArchivedSpaces()
      TRUE to index archived spaces.

    • getCrawlPersonalSpaces

      @Stability(Stable) @Nullable default Object getCrawlPersonalSpaces()
      TRUE to index personal spaces.

      You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context .

    • getExcludeSpaces

      @Stability(Stable) @Nullable default List<String> getExcludeSpaces()
      A list of space keys of Confluence spaces.

      If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

    • getIncludeSpaces

      @Stability(Stable) @Nullable default List<String> getIncludeSpaces()
      A list of space keys for Confluence spaces.

      If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

    • getSpaceFieldMappings

      @Stability(Stable) @Nullable default Object getSpaceFieldMappings()
      Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.

      To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

      If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

    • builder

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