SharePointConfiguration class

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

Constructors

SharePointConfiguration({required String secretArn, required SharePointVersion sharePointVersion, required List<String> urls, bool? crawlAttachments, bool? disableLocalGroups, String? documentTitleFieldName, List<String>? exclusionPatterns, List<DataSourceToIndexFieldMapping>? fieldMappings, List<String>? inclusionPatterns, bool? useChangeLog, DataSourceVpcConfiguration? vpcConfiguration})

SharePointConfiguration.fromJson(Map<String, dynamic> json)

factory

Properties

crawlAttachments → bool?

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

final

disableLocalGroups → bool?

A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

final

documentTitleFieldName → String?

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

final

exclusionPatterns → List<String>?

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.

final

fieldMappings → List<DataSourceToIndexFieldMapping>?

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 operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

final

hashCode → int

The hash code for this object.

no setter, inherited

inclusionPatterns → List<String>?

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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secretArn → String

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.

final

sharePointVersion → SharePointVersion

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

final

urls → List<String>

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

final

useChangeLog → bool?

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.

final

vpcConfiguration → DataSourceVpcConfiguration?

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited