class Aws::Kendra::Types::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.

@note When making an API call, you may pass WorkDocsConfiguration

data as a hash:

    {
      organization_id: "OrganizationId", # required
      crawl_comments: false,
      use_change_log: false,
      inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
      exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
      field_mappings: [
        {
          data_source_field_name: "DataSourceFieldName", # required
          date_field_format: "DataSourceDateFieldFormat",
          index_field_name: "IndexFieldName", # required
        },
      ],
    }

@!attribute [rw] organization_id

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

You can find the organization ID in the [AWS Directory Service][1]
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.

[1]: https://console.aws.amazon.com/directoryservicev2/
@return [String]

@!attribute [rw] crawl_comments

`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`.
@return [Boolean]

@!attribute [rw] use_change_log

`TRUE` to use the change logs to update documents in your index
instead of scanning all documents.

If you are syncing your Amazon WorkDocs data source with your index
for the first time, all documents are scanned. After your first
sync, you can use the change logs to update your documents in your
index for future syncs.

The default is set to `FALSE`.
@return [Boolean]

@!attribute [rw] inclusion_patterns

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 pattern
and an exclusion pattern, the exclusion pattern takes precedence and
the file isn’t included in the index.
@return [Array<String>]

@!attribute [rw] exclusion_patterns

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 pattern
and an exclusion pattern, the exclusion pattern takes precedence and
the file isn’t included in the index.
@return [Array<String>]

@!attribute [rw] field_mappings

A list of `DataSourceToIndexFieldMapping` objects that map Amazon
WorkDocs field names to custom index field names in Amazon Kendra.
You must first create the custom index fields using the
`UpdateIndex` operation before you map to Amazon WorkDocs fields.
For more information, see [Mapping Data Source Fields][1]. The
Amazon WorkDocs data source field names need to exist in your Amazon
WorkDocs custom metadata.

[1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
@return [Array<Types::DataSourceToIndexFieldMapping>]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/WorkDocsConfiguration AWS API Documentation

Constants

SENSITIVE