kendra/aws.sdk.kotlin.services.kendra.model/SharePointConfiguration/Builder

Builder

Properties

var authenticationType: SharePointOnlineAuthenticationType?

Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

crawlAttachments

var crawlAttachments: Boolean

TRUE to index document attachments.

disableLocalGroups

var disableLocalGroups: Boolean

TRUE to disable local groups information.

documentTitleFieldName

var documentTitleFieldName: String?

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

exclusionPatterns

var exclusionPatterns: List<String>?

A list of regular expression patterns to exclude certain documents in your SharePoint. 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 inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

fieldMappings

var fieldMappings: List<DataSourceToIndexFieldMapping>?

A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.

inclusionPatterns

var inclusionPatterns: List<String>?

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.

proxyConfiguration

var proxyConfiguration: ProxyConfiguration?

Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

secretArn

var secretArn: String?

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.

sharePointVersion

var sharePointVersion: SharePointVersion?

The version of Microsoft SharePoint that you use.

sslCertificateS3Path

var sslCertificateS3Path: S3Path?

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.

urls

var urls: List<String>?

The Microsoft SharePoint site URLs for the documents you want to index.

useChangeLog

var useChangeLog: Boolean

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.

vpcConfiguration

var vpcConfiguration: DataSourceVpcConfiguration?

Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.

Functions

proxyConfiguration

fun proxyConfiguration(block: ProxyConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kendra.model.ProxyConfiguration inside the given block

sslCertificateS3Path

fun sslCertificateS3Path(block: S3Path.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kendra.model.S3Path inside the given block

vpcConfiguration

fun vpcConfiguration(block: DataSourceVpcConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kendra.model.DataSourceVpcConfiguration inside the given block