interface OneDriveConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnDataSource.OneDriveConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_OneDriveConfigurationProperty`
Java	`software.amazon.awscdk.services.kendra.CfnDataSource.OneDriveConfigurationProperty`
Python	`aws_cdk.aws_kendra.CfnDataSource.OneDriveConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_kendra` » `CfnDataSource` » `OneDriveConfigurationProperty`

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const oneDriveConfigurationProperty: kendra.CfnDataSource.OneDriveConfigurationProperty = {
  oneDriveUsers: {
    oneDriveUserList: ['oneDriveUserList'],
    oneDriveUserS3Path: {
      bucket: 'bucket',
      key: 'key',
    },
  },
  secretArn: 'secretArn',
  tenantDomain: 'tenantDomain',

  // the properties below are optional
  disableLocalGroups: false,
  exclusionPatterns: ['exclusionPatterns'],
  fieldMappings: [{
    dataSourceFieldName: 'dataSourceFieldName',
    indexFieldName: 'indexFieldName',

    // the properties below are optional
    dateFieldFormat: 'dateFieldFormat',
  }],
  inclusionPatterns: ['inclusionPatterns'],
};

Properties

Name	Type	Description
oneDriveUsers	`IResolvable` `\|` `OneDriveUsersProperty`	A list of user accounts whose documents should be indexed.
secretArn	`string`	The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive.
tenantDomain	`string`	The Azure Active Directory domain of the organization.
disableLocalGroups?	`boolean \|` `IResolvable`	`TRUE` to disable local groups information.
exclusionPatterns?	`string[]`	A list of regular expression patterns to exclude certain documents in your OneDrive.
fieldMappings?	`IResolvable` `\|` `IResolvable` `\|` `DataSourceToIndexFieldMappingProperty[]`	A list of `DataSourceToIndexFieldMapping` objects that map OneDrive data source attributes or field names to Amazon Kendra index field names.
inclusionPatterns?	`string[]`	A list of regular expression patterns to include certain documents in your OneDrive.

oneDriveUsers

Type: IResolvable | OneDriveUsersProperty

A list of user accounts whose documents should be indexed.

secretArn

Type: string

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret 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.

tenantDomain

Type: string

The Azure Active Directory domain of the organization.

disableLocalGroups?

Type: boolean | IResolvable (optional)

TRUE to disable local groups information.

exclusionPatterns?

Type: string[] (optional)

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.

fieldMappings?

Type: IResolvable | IResolvable | DataSourceToIndexFieldMappingProperty[] (optional)

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.

inclusionPatterns?

Type: string[] (optional)

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.