Documentation

Provides the configuration information to connect to OneDrive as your data source.

See: newOneDriveConfiguration smart constructor.

Create a value of OneDriveConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:disableLocalGroups:OneDriveConfiguration', oneDriveConfiguration_disableLocalGroups - TRUE to disable local groups information.

$sel:exclusionPatterns:OneDriveConfiguration', oneDriveConfiguration_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.

$sel:fieldMappings:OneDriveConfiguration', oneDriveConfiguration_fieldMappings - A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API 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.

$sel:inclusionPatterns:OneDriveConfiguration', oneDriveConfiguration_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.

$sel:tenantDomain:OneDriveConfiguration', oneDriveConfiguration_tenantDomain - The Azure Active Directory domain of the organization.

$sel:secretArn:OneDriveConfiguration', oneDriveConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

$sel:oneDriveUsers:OneDriveConfiguration', oneDriveConfiguration_oneDriveUsers - A list of user accounts whose documents should be indexed.

TRUE to disable local groups information.

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.

A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API 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.

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.

The Azure Active Directory domain of the organization.

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

A list of user accounts whose documents should be indexed.