software.amazon.awscdk.services.kendra

Interface CfnDataSource.OneDriveConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.OneDriveConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.OneDriveConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.OneDriveConfigurationProperty.Builder A builder for CfnDataSource.OneDriveConfigurationProperty
static class	CfnDataSource.OneDriveConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.OneDriveConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.OneDriveConfigurationProperty.Builder	builder()
default Object	getDisableLocalGroups() A Boolean value that specifies whether local groups are disabled ( `True` ) or enabled ( `False` ).
default List<String>	getExclusionPatterns() A list of regular expression patterns to exclude certain documents in your OneDrive.
default Object	getFieldMappings() A list of `DataSourceToIndexFieldMapping` objects that map OneDrive data source attributes or field names to Amazon Kendra index field names.
default List<String>	getInclusionPatterns() A list of regular expression patterns to include certain documents in your OneDrive.
Object	getOneDriveUsers() A list of user accounts whose documents should be indexed.
String	getSecretArn() The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive.
String	getTenantDomain() The Azure Active Directory domain of the organization.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOneDriveUsers

@Stability(value=Stable)
 @NotNull
Object getOneDriveUsers()

A list of user accounts whose documents should be indexed.

getSecretArn

@Stability(value=Stable)
 @NotNull
String 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 named should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

getTenantDomain

@Stability(value=Stable)
 @NotNull
String getTenantDomain()

The Azure Active Directory domain of the organization.

getDisableLocalGroups

@Stability(value=Stable)
 @Nullable
default Object getDisableLocalGroups()

A Boolean value that specifies whether local groups are disabled ( `True` ) or enabled ( `False` ).

getExclusionPatterns

@Stability(value=Stable)
 @Nullable
default List<String> 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.

getFieldMappings

@Stability(value=Stable)
 @Nullable
default Object getFieldMappings()

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.

getInclusionPatterns

@Stability(value=Stable)
 @Nullable
default List<String> 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.

builder

@Stability(value=Stable)
static CfnDataSource.OneDriveConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.OneDriveConfigurationProperty.Builder of CfnDataSource.OneDriveConfigurationProperty