Interface CfnDataSource.OneDriveConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSource.OneDriveConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDataSource
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;
OneDriveConfigurationProperty oneDriveConfigurationProperty = OneDriveConfigurationProperty.builder()
.oneDriveUsers(OneDriveUsersProperty.builder()
.oneDriveUserList(List.of("oneDriveUserList"))
.oneDriveUserS3Path(S3PathProperty.builder()
.bucket("bucket")
.key("key")
.build())
.build())
.secretArn("secretArn")
.tenantDomain("tenantDomain")
// the properties below are optional
.disableLocalGroups(false)
.exclusionPatterns(List.of("exclusionPatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.inclusionPatterns(List.of("inclusionPatterns"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDataSource.OneDriveConfigurationPropertystatic final classAn implementation forCfnDataSource.OneDriveConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectTRUEto disable local groups information.A list of regular expression patterns to exclude certain documents in your OneDrive.default ObjectA list ofDataSourceToIndexFieldMappingobjects that map OneDrive data source attributes or field names to Amazon Kendra index field names.A list of regular expression patterns to include certain documents in your OneDrive.A list of user accounts whose documents should be indexed.The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive.The Azure Active Directory domain of the organization.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getOneDriveUsers
A list of user accounts whose documents should be indexed.- See Also:
-
getSecretArn
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.
- See Also:
-
getTenantDomain
The Azure Active Directory domain of the organization.- See Also:
-
getDisableLocalGroups
TRUEto disable local groups information.- See Also:
-
getExclusionPatterns
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.
- See Also:
-
getFieldMappings
A list ofDataSourceToIndexFieldMappingobjects that map OneDrive data source attributes or field names to Amazon Kendra index field names.To create custom fields, use the
UpdateIndexAPI 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.- See Also:
-
getInclusionPatterns
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.
- See Also:
-
builder
-