AWS::Kendra::DataSource SharePointConfiguration - AWS CloudFormation

AWS::Kendra::DataSource SharePointConfiguration

Provides configuration information for connecting to a Microsoft SharePoint data source.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

Properties

CrawlAttachments

TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.

Required: No

Type: Boolean

Update requires: No interruption

DocumentTitleFieldName

The Microsoft SharePoint attribute field that contains the title of the document.

Required: No

Type: String

Minimum: 1

Maximum: 100

Pattern: ^[a-zA-Z][a-zA-Z0-9_.]*$

Update requires: No interruption

ExclusionPatterns

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Required: No

Type: DataSourceInclusionsExclusionsStrings

Maximum: 100

Update requires: No interruption

FieldMappings

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

Required: No

Type: DataSourceToIndexFieldMappingList

Maximum: 100

Update requires: No interruption

InclusionPatterns

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Required: No

Type: DataSourceInclusionsExclusionsStrings

Maximum: 100

Update requires: No interruption

SecretArn

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Required: Yes

Type: String

Minimum: 1

Maximum: 1284

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Update requires: No interruption

SharePointVersion

The version of Microsoft SharePoint that you are using as a data source.

Required: Yes

Type: String

Allowed values: SHAREPOINT_ONLINE

Update requires: No interruption

Urls

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Required: Yes

Type: List of String

Maximum: 100

Update requires: No interruption

UseChangeLog

Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

Required: No

Type: Boolean

Update requires: No interruption

VpcConfiguration

Not currently supported by AWS CloudFormation.

Required: No

Type: DataSourceVpcConfiguration

Update requires: No interruption