1.204.0

interface SharePointConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.SharePointConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.SharePointConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.SharePointConfigurationProperty
TypeScript @aws-cdk/aws-kendra » CfnDataSource » SharePointConfigurationProperty

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 * as kendra from '@aws-cdk/aws-kendra';
const sharePointConfigurationProperty: kendra.CfnDataSource.SharePointConfigurationProperty = {
  secretArn: 'secretArn',
  sharePointVersion: 'sharePointVersion',
  urls: ['urls'],

  // the properties below are optional
  crawlAttachments: false,
  disableLocalGroups: false,
  documentTitleFieldName: 'documentTitleFieldName',
  exclusionPatterns: ['exclusionPatterns'],
  fieldMappings: [{
    dataSourceFieldName: 'dataSourceFieldName',
    indexFieldName: 'indexFieldName',

    // the properties below are optional
    dateFieldFormat: 'dateFieldFormat',
  }],
  inclusionPatterns: ['inclusionPatterns'],
  sslCertificateS3Path: {
    bucket: 'bucket',
    key: 'key',
  },
  useChangeLog: false,
  vpcConfiguration: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
};

Properties

NameTypeDescription
secretArnstringThe Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance.
sharePointVersionstringThe version of Microsoft SharePoint that you use.
urlsstring[]The Microsoft SharePoint site URLs for the documents you want to index.
crawlAttachments?boolean | IResolvableTRUE to index document attachments.
disableLocalGroups?boolean | IResolvableTRUE to disable local groups information.
documentTitleFieldName?stringThe Microsoft SharePoint attribute field that contains the title of the document.
exclusionPatterns?string[]A list of regular expression patterns.
fieldMappings?IResolvable | IResolvable | DataSourceToIndexFieldMappingProperty[]A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields.
inclusionPatterns?string[]A list of regular expression patterns to include certain documents in your SharePoint.
sslCertificateS3Path?IResolvable | S3PathPropertyInformation required to find a specific file in an Amazon S3 bucket.
useChangeLog?boolean | IResolvableTRUE to use the SharePoint change log to determine which documents require updating in the index.
vpcConfiguration?IResolvable | DataSourceVpcConfigurationPropertyProvides information for connecting to an Amazon VPC.

secretArn

Type: string

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 .

sharePointVersion

Type: string

The version of Microsoft SharePoint that you use.

urls

Type: string[]

The Microsoft SharePoint site URLs for the documents you want to index.

crawlAttachments?

Type: boolean | IResolvable (optional)

TRUE to index document attachments.

disableLocalGroups?

Type: boolean | IResolvable (optional)

TRUE to disable local groups information.

documentTitleFieldName?

Type: string (optional)

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

exclusionPatterns?

Type: string[] (optional)

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.

fieldMappings?

Type: IResolvable | IResolvable | DataSourceToIndexFieldMappingProperty[] (optional)

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 .

inclusionPatterns?

Type: string[] (optional)

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.

sslCertificateS3Path?

Type: IResolvable | S3PathProperty (optional)

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

useChangeLog?

Type: boolean | IResolvable (optional)

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.

vpcConfiguration?

Type: IResolvable | DataSourceVpcConfigurationProperty (optional)

Provides information for connecting to an Amazon VPC.

← PreviousNext →