software.amazon.awscdk.services.kendra

Interface CfnDataSource.WorkDocsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.WorkDocsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

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

Provides the configuration information to connect to Amazon WorkDocs as your data source.

Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.

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.*;
 WorkDocsConfigurationProperty workDocsConfigurationProperty = WorkDocsConfigurationProperty.builder()
         .organizationId("organizationId")
         // the properties below are optional
         .crawlComments(false)
         .exclusionPatterns(List.of("exclusionPatterns"))
         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .indexFieldName("indexFieldName")
                 // the properties below are optional
                 .dateFieldFormat("dateFieldFormat")
                 .build()))
         .inclusionPatterns(List.of("inclusionPatterns"))
         .useChangeLog(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.WorkDocsConfigurationProperty.Builder	builder()
default Object	getCrawlComments() `TRUE` to include comments on documents in your index.
default List<String>	getExclusionPatterns() A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.
default Object	getFieldMappings() A list of `DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names.
default List<String>	getInclusionPatterns() A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.
String	getOrganizationId() The identifier of the directory corresponding to your Amazon WorkDocs site repository.
default Object	getUseChangeLog() `TRUE` to use the Amazon WorkDocs change log to determine which documents require updating in the index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOrganizationId

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

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the AWS Directory Service by going to Active Directory , then Directories . Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

getCrawlComments

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

`TRUE` to include comments on documents in your index.

Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE .

getExclusionPatterns

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

A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.

Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

getFieldMappings

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

A list of `DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names.

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

getInclusionPatterns

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

A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.

Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

getUseChangeLog

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

`TRUE` to use the Amazon WorkDocs change log to determine which documents require updating in the index.

Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.

builder

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

Returns:

a CfnDataSource.WorkDocsConfigurationProperty.Builder of CfnDataSource.WorkDocsConfigurationProperty