Interface CfnDataSource.IOneDriveConfigurationProperty
Provides the configuration information to connect to OneDrive as your data source.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.AWS.Kendra.dll
Syntax (csharp)
public interface IOneDriveConfigurationProperty
Syntax (vb)
Public Interface IOneDriveConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var oneDriveConfigurationProperty = new OneDriveConfigurationProperty {
OneDriveUsers = new OneDriveUsersProperty {
OneDriveUserList = new [] { "oneDriveUserList" },
OneDriveUserS3Path = new S3PathProperty {
Bucket = "bucket",
Key = "key"
}
},
SecretArn = "secretArn",
TenantDomain = "tenantDomain",
// the properties below are optional
DisableLocalGroups = false,
ExclusionPatterns = new [] { "exclusionPatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
InclusionPatterns = new [] { "inclusionPatterns" }
};
Synopsis
Properties
DisableLocalGroups |
|
ExclusionPatterns | A list of regular expression patterns to exclude certain documents in your OneDrive. |
FieldMappings | A list of |
InclusionPatterns | A list of regular expression patterns to include certain documents in your OneDrive. |
OneDriveUsers | A list of user accounts whose documents should be indexed. |
SecretArn | The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. |
TenantDomain | The Azure Active Directory domain of the organization. |
Properties
DisableLocalGroups
TRUE
to disable local groups information.
virtual object DisableLocalGroups { get; }
Property Value
System.Object
Remarks
ExclusionPatterns
A list of regular expression patterns to exclude certain documents in your OneDrive.
virtual string[] ExclusionPatterns { get; }
Property Value
System.String[]
Remarks
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
A list of DataSourceToIndexFieldMapping
objects that map OneDrive data source attributes or field names to Amazon Kendra index field names.
virtual object FieldMappings { get; }
Property Value
System.Object
Remarks
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
A list of regular expression patterns to include certain documents in your OneDrive.
virtual string[] InclusionPatterns { get; }
Property Value
System.String[]
Remarks
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.
OneDriveUsers
A list of user accounts whose documents should be indexed.
object OneDriveUsers { get; }
Property Value
System.Object
Remarks
SecretArn
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive.
string SecretArn { get; }
Property Value
System.String
Remarks
The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
TenantDomain
The Azure Active Directory domain of the organization.
string TenantDomain { get; }
Property Value
System.String