AWS::Kendra::DataSource SharePointConfiguration
Provides the configuration information to connect to Microsoft SharePoint as your data source.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CrawlAttachments" :
Boolean
, "DisableLocalGroups" :Boolean
, "DocumentTitleFieldName" :String
, "ExclusionPatterns" :[ String, ... ]
, "FieldMappings" :[ DataSourceToIndexFieldMapping, ... ]
, "InclusionPatterns" :[ String, ... ]
, "SecretArn" :String
, "SharePointVersion" :String
, "SslCertificateS3Path" :S3Path
, "Urls" :[ String, ... ]
, "UseChangeLog" :Boolean
, "VpcConfiguration" :DataSourceVpcConfiguration
}
YAML
CrawlAttachments:
Boolean
DisableLocalGroups:Boolean
DocumentTitleFieldName:String
ExclusionPatterns:- String
FieldMappings:- DataSourceToIndexFieldMapping
InclusionPatterns:- String
SecretArn:String
SharePointVersion:String
SslCertificateS3Path:S3Path
Urls:- String
UseChangeLog:Boolean
VpcConfiguration:DataSourceVpcConfiguration
Properties
CrawlAttachments
-
TRUE
to index document attachments.Required: No
Type: Boolean
Update requires: No interruption
DisableLocalGroups
-
TRUE
to disable local groups information.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: List of String
Maximum:
100
Update requires: No interruption
FieldMappings
-
A list of
DataSourceToIndexFieldMapping
objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields. 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: List of DataSourceToIndexFieldMapping
Maximum:
100
Update requires: No interruption
InclusionPatterns
-
A list of regular expression patterns to include certain documents in your SharePoint. 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 and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
Required: No
Type: List of String
Maximum:
100
Update requires: No interruption
SecretArn
-
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.
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 use.
Required: Yes
Type: String
Allowed values:
SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_2019 | SHAREPOINT_ONLINE
Update requires: No interruption
SslCertificateS3Path
-
Information required to find a specific file in an Amazon S3 bucket.
Required: No
Type: S3Path
Update requires: No interruption
Urls
-
The Microsoft SharePoint site URLs for the documents you want to index.
Required: Yes
Type: List of String
Maximum:
100
Update requires: No interruption
UseChangeLog
-
TRUE
to use the SharePoint 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 SharePoint.Required: No
Type: Boolean
Update requires: No interruption
VpcConfiguration
Provides information for connecting to an Amazon VPC.
Required: No
Type: DataSourceVpcConfiguration
Update requires: No interruption