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

  • Method Details

    • getSecretArn

      @Stability(Stable) @NotNull String getSecretArn()
      The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance.

      For more information, see Microsoft SharePoint .

    • getSharePointVersion

      @Stability(Stable) @NotNull String getSharePointVersion()
      The version of Microsoft SharePoint that you use.

    • getUrls

      @Stability(Stable) @NotNull List<String> getUrls()
      The Microsoft SharePoint site URLs for the documents you want to index.

    • getCrawlAttachments

      @Stability(Stable) @Nullable default Object getCrawlAttachments()
      TRUE to index document attachments.

    • getDisableLocalGroups

      @Stability(Stable) @Nullable default Object getDisableLocalGroups()
      TRUE to disable local groups information.

    • getDocumentTitleFieldName

      @Stability(Stable) @Nullable default String getDocumentTitleFieldName()
      The Microsoft SharePoint attribute field that contains the title of the document.

    • getExclusionPatterns

      @Stability(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(Stable) @Nullable default Object getFieldMappings()
      A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields.

      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(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 applies to the display URL of the SharePoint document.

    • getSslCertificateS3Path

      @Stability(Stable) @Nullable default Object getSslCertificateS3Path()
      Information required to find a specific file in an Amazon S3 bucket.

    • getUseChangeLog

      @Stability(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(Stable) @Nullable default Object getVpcConfiguration()
      Provides information for connecting to an Amazon VPC.

    • builder

      @Stability(Stable) static CfnDataSource.SharePointConfigurationProperty.Builder builder()
      Returns:
      a CfnDataSource.SharePointConfigurationProperty.Builder of CfnDataSource.SharePointConfigurationProperty