OneDriveConfiguration
Provides the configuration information to connect to OneDrive as your data source.
Contents
- OneDriveUsers
-
A list of user accounts whose documents should be indexed.
Type: OneDriveUsers object
Required: Yes
- SecretArn
-
The Amazon Resource Name (ARN) of an AWS Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 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}Required: Yes
- TenantDomain
-
The Azure Active Directory domain of the organization.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-z]{2,}$Required: Yes
- DisableLocalGroups
-
TRUEto disable local groups information.Type: Boolean
Required: No
- ExclusionPatterns
-
A list of regular expression patterns to exclude certain documents in your OneDrive. 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.
The pattern is applied to the file name.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- FieldMappings
-
A list of
DataSourceToIndexFieldMappingobjects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndexAPI before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.Type: Array of DataSourceToIndexFieldMapping objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
- InclusionPatterns
-
A list of regular expression patterns to include certain documents in your OneDrive. 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 pattern is applied to the file name.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
