import { Value } from '../../../cloudformation/Value';
import { DataSourceToIndexFieldMappingProps } from './DataSourceToIndexFieldMappingProps';
/**
  Provides the configuration information to connect to Amazon WorkDocs as your data source.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html">the AWS Docs</a>
*/
export interface WorkDocsConfigurationProps {
    /** <code>CrawlComments</code>  <a name="cfn-kendra-datasource-workdocsconfiguration-crawlcomments"></a>
  <code>TRUE</code> to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.<br />
  The default is set to <code>FALSE</code>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    crawlComments?: Value<boolean>;
    /** <code>OrganizationId</code>  <a name="cfn-kendra-datasource-workdocsconfiguration-organizationid"></a>
  The identifier of the directory corresponding to your Amazon WorkDocs site repository.<br />
  You can find the organization ID in the <a href="https://console.aws.amazon.com/directoryservicev2/">AWS Directory Service</a> by going to <strong>Active Directory</strong>, then <strong>Directories</strong>. 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.<br />
  
  Required: Yes<br />
  
  Minimum: <code>12</code><br />
  
  Maximum: <code>12</code><br />
  
  Pattern: <code>d-[0-9a-fA-F]{10}</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    organizationId: Value<string>;
    /** <code>InclusionPatterns</code>  <a name="cfn-kendra-datasource-workdocsconfiguration-inclusionpatterns"></a>
  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.<br />
  
  Required: No<br />
  
  Maximum: <code>250</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    inclusionPatterns?: Value<Value<string>[]>;
    /** <code>UseChangeLog</code>  <a name="cfn-kendra-datasource-workdocsconfiguration-usechangelog"></a>
  <code>TRUE</code> 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.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    useChangeLog?: Value<boolean>;
    /** <code>FieldMappings</code>  <a name="cfn-kendra-datasource-workdocsconfiguration-fieldmappings"></a>
  A list of <code>DataSourceToIndexFieldMapping</code> objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Amazon WorkDocs fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.<br />
  
  Required: No<br />
  
  Maximum: <code>100</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    fieldMappings?: DataSourceToIndexFieldMappingProps[];
    /** <code>ExclusionPatterns</code>  <a name="cfn-kendra-datasource-workdocsconfiguration-exclusionpatterns"></a>
  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.<br />
  
  Required: No<br />
  
  Maximum: <code>250</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    exclusionPatterns?: Value<Value<string>[]>;
}
