software.amazon.awscdk.services.kendra

Interface CfnDataSource.SharePointConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.SharePointConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

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

Provides the configuration information to connect to Microsoft SharePoint 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.*;
 SharePointConfigurationProperty sharePointConfigurationProperty = SharePointConfigurationProperty.builder()
         .secretArn("secretArn")
         .sharePointVersion("sharePointVersion")
         .urls(List.of("urls"))
         // the properties below are optional
         .crawlAttachments(false)
         .disableLocalGroups(false)
         .documentTitleFieldName("documentTitleFieldName")
         .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"))
         .sslCertificateS3Path(S3PathProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         .useChangeLog(false)
         .vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.SharePointConfigurationProperty.Builder	builder()
default Object	getCrawlAttachments() `TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index;
default Object	getDisableLocalGroups() A Boolean value that specifies whether local groups are disabled ( `True` ) or enabled ( `False` ).
default String	getDocumentTitleFieldName() The Microsoft SharePoint attribute field that contains the title of the document.
default List<String>	getExclusionPatterns() A list of regular expression patterns.
default Object	getFieldMappings() A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index.
default List<String>	getInclusionPatterns() A list of regular expression patterns to include certain documents in your SharePoint.
String	getSecretArn() The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager .
String	getSharePointVersion() The version of Microsoft SharePoint that you are using as a data source.
default Object	getSslCertificateS3Path() Information required to find a specific file in an Amazon S3 bucket.
List<String>	getUrls() The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
default Object	getUseChangeLog() `TRUE` to use the SharePoint change log to determine which documents require updating in the index.
default Object	getVpcConfiguration() Provides information for connecting to an Amazon VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSecretArn

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

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager .

The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source . For more information about AWS Secrets Manager see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

getSharePointVersion

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

The version of Microsoft SharePoint that you are using as a data source.

getUrls

@Stability(value=Stable)
 @NotNull
List<String> getUrls()

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

getCrawlAttachments

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

`TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index;

otherwise, FALSE .

getDisableLocalGroups

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

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

getDocumentTitleFieldName

@Stability(value=Stable)
 @Nullable
default String getDocumentTitleFieldName()

The Microsoft SharePoint attribute field that contains the title of the document.

getExclusionPatterns

@Stability(value=Stable)
 @Nullable
default List<String> getExclusionPatterns()

A list of regular expression patterns.

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 exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

getFieldMappings

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

A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index.

You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields .

getInclusionPatterns

@Stability(value=Stable)
 @Nullable
default List<String> getInclusionPatterns()

A list of regular expression patterns to include certain documents in your SharePoint.

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 regex is applied to the display URL of the SharePoint document.

getSslCertificateS3Path

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

Information required to find a specific file in an Amazon S3 bucket.

getUseChangeLog

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

`TRUE` to use the SharePoint change log to determine which documents require updating in the index.

Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

getVpcConfiguration

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

Provides information for connecting to an Amazon VPC.

builder

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

Returns:

a CfnDataSource.SharePointConfigurationProperty.Builder of CfnDataSource.SharePointConfigurationProperty