Class CfnDataSource.WorkDocsConfigurationProperty
Provides the configuration information to connect to Amazon WorkDocs as your data source.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.AWS.Kendra.dll
Syntax (csharp)
public class WorkDocsConfigurationProperty : Object, CfnDataSource.IWorkDocsConfigurationProperty
Syntax (vb)
Public Class WorkDocsConfigurationProperty
Inherits Object
Implements CfnDataSource.IWorkDocsConfigurationProperty
Remarks
Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var workDocsConfigurationProperty = new WorkDocsConfigurationProperty {
OrganizationId = "organizationId",
// the properties below are optional
CrawlComments = false,
ExclusionPatterns = new [] { "exclusionPatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
InclusionPatterns = new [] { "inclusionPatterns" },
UseChangeLog = false
};
Synopsis
Constructors
WorkDocsConfigurationProperty() |
Properties
CrawlComments |
|
ExclusionPatterns | A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. |
FieldMappings | A list of |
InclusionPatterns | A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. |
OrganizationId | The identifier of the directory corresponding to your Amazon WorkDocs site repository. |
UseChangeLog |
|
Constructors
WorkDocsConfigurationProperty()
public WorkDocsConfigurationProperty()
Properties
CrawlComments
TRUE
to include comments on documents in your index.
public object CrawlComments { get; set; }
Property Value
System.Object
Remarks
Including comments in your index means each comment is a document that can be searched on.
The default is set to FALSE
.
ExclusionPatterns
A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.
public string[] ExclusionPatterns { get; set; }
Property Value
System.String[]
Remarks
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.
FieldMappings
A list of DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names.
public object FieldMappings { get; set; }
Property Value
System.Object
Remarks
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.
InclusionPatterns
A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.
public string[] InclusionPatterns { get; set; }
Property Value
System.String[]
Remarks
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.
OrganizationId
The identifier of the directory corresponding to your Amazon WorkDocs site repository.
public string OrganizationId { get; set; }
Property Value
System.String
Remarks
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.
UseChangeLog
TRUE
to use the Amazon WorkDocs change log to determine which documents require updating in the index.
public object UseChangeLog { get; set; }
Property Value
System.Object
Remarks
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.