Class CfnDataSourcePropsMixin.WorkDocsConfigurationProperty

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

Inheritance

object

CfnDataSourcePropsMixin.WorkDocsConfigurationProperty

Implements

CfnDataSourcePropsMixin.IWorkDocsConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Kendra

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnDataSourcePropsMixin.WorkDocsConfigurationProperty : CfnDataSourcePropsMixin.IWorkDocsConfigurationProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.WorkDocsConfigurationProperty Implements CfnDataSourcePropsMixin.IWorkDocsConfigurationProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html

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.CfnPropertyMixins.AWS.Kendra;

             var workDocsConfigurationProperty = new WorkDocsConfigurationProperty {
                 CrawlComments = false,
                 ExclusionPatterns = new [] { "exclusionPatterns" },
                 FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } },
                 InclusionPatterns = new [] { "inclusionPatterns" },
                 OrganizationId = "organizationId",
                 UseChangeLog = false
             };

Synopsis

Constructors

WorkDocsConfigurationProperty()

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

Properties

CrawlComments	`TRUE` to include comments on documents in your index.
ExclusionPatterns	A list of regular expression patterns to exclude certain files in your WorkDocs site repository.
FieldMappings	A list of `DataSourceToIndexFieldMapping` objects that map WorkDocs data source attributes or field names to Amazon Kendra index field names.
InclusionPatterns	A list of regular expression patterns to include certain files in your WorkDocs site repository.
OrganizationId	The identifier of the directory corresponding to your WorkDocs site repository.
UseChangeLog	`TRUE` to use the WorkDocs change log to determine which documents require updating in the index.

Constructors

WorkDocsConfigurationProperty()

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

public WorkDocsConfigurationProperty()

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html

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.CfnPropertyMixins.AWS.Kendra;

             var workDocsConfigurationProperty = new WorkDocsConfigurationProperty {
                 CrawlComments = false,
                 ExclusionPatterns = new [] { "exclusionPatterns" },
                 FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } },
                 InclusionPatterns = new [] { "inclusionPatterns" },
                 OrganizationId = "organizationId",
                 UseChangeLog = false
             };

Properties

CrawlComments

TRUE to include comments on documents in your index.

public object? CrawlComments { get; set; }

Property Value

object

Remarks

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

The default is set to FALSE .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-crawlcomments

Type union: either bool or IResolvable

ExclusionPatterns

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

public string[]? ExclusionPatterns { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-exclusionpatterns

FieldMappings

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

public object? FieldMappings { get; set; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-fieldmappings

Type union: either IResolvable or (either IResolvable or CfnDataSourcePropsMixin.IDataSourceToIndexFieldMappingProperty)[]

InclusionPatterns

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

public string[]? InclusionPatterns { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-inclusionpatterns

OrganizationId

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

public string? OrganizationId { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-organizationid

UseChangeLog

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

public object? UseChangeLog { get; set; }

Property Value

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 WorkDocs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-usechangelog

Type union: either bool or IResolvable

Implements

CfnDataSourcePropsMixin.IWorkDocsConfigurationProperty