AWS::Kendra::DataSource WorkDocsConfiguration
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.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "CrawlComments" :
Boolean
, "ExclusionPatterns" :[ String, ... ]
, "FieldMappings" :[ DataSourceToIndexFieldMapping, ... ]
, "InclusionPatterns" :[ String, ... ]
, "OrganizationId" :String
, "UseChangeLog" :Boolean
}
YAML
CrawlComments:
Boolean
ExclusionPatterns:- String
FieldMappings:- DataSourceToIndexFieldMapping
InclusionPatterns:- String
OrganizationId:String
UseChangeLog:Boolean
Properties
CrawlComments
-
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
.Required: No
Type: Boolean
Update requires: No interruption
ExclusionPatterns
-
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.
Required: No
Type: Array of String
Minimum:
1
Maximum:
50 | 100
Update requires: No interruption
FieldMappings
-
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 theUpdateIndex
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.Required: No
Type: Array of DataSourceToIndexFieldMapping
Maximum:
100
Update requires: No interruption
InclusionPatterns
-
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.
Required: No
Type: Array of String
Minimum:
1
Maximum:
50 | 100
Update requires: No interruption
OrganizationId
-
The identifier of the directory corresponding to your Amazon WorkDocs site repository.
You can find the organization ID in the Amazon 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 Amazon Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console. Required: Yes
Type: String
Pattern:
d-[0-9a-fA-F]{10}
Minimum:
12
Maximum:
12
Update requires: No interruption
UseChangeLog
-
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.Required: No
Type: Boolean
Update requires: No interruption