Skip to content
v2.278.0

SharePointConfigurationProperty Struct ​

Provides the configuration information to connect to Microsoft SharePoint as your data source.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
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'],
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

share_point_configuration_property = kendra.CfnDataSource.SharePointConfigurationProperty(
    secret_arn="secretArn",
    share_point_version="sharePointVersion",
    urls=["urls"],

    # the properties below are optional
    crawl_attachments=False,
    disable_local_groups=False,
    document_title_field_name="documentTitleFieldName",
    exclusion_patterns=["exclusionPatterns"],
    field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
        data_source_field_name="dataSourceFieldName",
        index_field_name="indexFieldName",

        # the properties below are optional
        date_field_format="dateFieldFormat"
    )],
    inclusion_patterns=["inclusionPatterns"],
    ssl_certificate_s3_path=kendra.CfnDataSource.S3PathProperty(
        bucket="bucket",
        key="key"
    ),
    use_change_log=False,
    vpc_configuration=kendra.CfnDataSource.DataSourceVpcConfigurationProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var sharePointConfigurationProperty = new SharePointConfigurationProperty {
    SecretArn = "secretArn",
    SharePointVersion = "sharePointVersion",
    Urls = new [] { "urls" },

    // the properties below are optional
    CrawlAttachments = false,
    DisableLocalGroups = false,
    DocumentTitleFieldName = "documentTitleFieldName",
    ExclusionPatterns = new [] { "exclusionPatterns" },
    FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
        DataSourceFieldName = "dataSourceFieldName",
        IndexFieldName = "indexFieldName",

        // the properties below are optional
        DateFieldFormat = "dateFieldFormat"
    } },
    InclusionPatterns = new [] { "inclusionPatterns" },
    SslCertificateS3Path = new S3PathProperty {
        Bucket = "bucket",
        Key = "key"
    },
    UseChangeLog = false,
    VpcConfiguration = new DataSourceVpcConfigurationProperty {
        SecurityGroupIds = new [] { "securityGroupIds" },
        SubnetIds = new [] { "subnetIds" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

sharePointConfigurationProperty := &SharePointConfigurationProperty{
	SecretArn: jsii.String("secretArn"),
	SharePointVersion: jsii.String("sharePointVersion"),
	Urls: []*string{
		jsii.String("urls"),
	},

	// the properties below are optional
	CrawlAttachments: jsii.Boolean(false),
	DisableLocalGroups: jsii.Boolean(false),
	DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
	ExclusionPatterns: []*string{
		jsii.String("exclusionPatterns"),
	},
	FieldMappings: []interface{}{
		&DataSourceToIndexFieldMappingProperty{
			DataSourceFieldName: jsii.String("dataSourceFieldName"),
			IndexFieldName: jsii.String("indexFieldName"),

			// the properties below are optional
			DateFieldFormat: jsii.String("dateFieldFormat"),
		},
	},
	InclusionPatterns: []*string{
		jsii.String("inclusionPatterns"),
	},
	SslCertificateS3Path: &S3PathProperty{
		Bucket: jsii.String("bucket"),
		Key: jsii.String("key"),
	},
	UseChangeLog: jsii.Boolean(false),
	VpcConfiguration: &DataSourceVpcConfigurationProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		SubnetIds: []*string{
			jsii.String("subnetIds"),
		},
	},
}

Properties ​

crawlAttachmentsoptionalboolean | IResolvablecrawl_attachmentsoptionaltyping.Union[bool, IResolvable]crawlAttachmentsoptionalBooleanCrawlAttachmentsoptionalboolCrawlAttachmentsoptionalinterface{} #
`TRUE` to index document attachments.
disableLocalGroupsoptionalboolean | IResolvabledisable_local_groupsoptionaltyping.Union[bool, IResolvable]disableLocalGroupsoptionalBooleanDisableLocalGroupsoptionalboolDisableLocalGroupsoptionalinterface{} #
`TRUE` to disable local groups information.
documentTitleFieldNameoptionalstringdocument_title_field_nameoptionalstrdocumentTitleFieldNameoptionalStringDocumentTitleFieldNameoptionalstringDocumentTitleFieldNameoptional*string #
The Microsoft SharePoint attribute field that contains the title of the document.
exclusionPatternsoptionalstring[]exclusion_patternsoptionaltyping.List[str]exclusionPatternsoptionalList<String>ExclusionPatternsoptionalstring[]ExclusionPatternsoptional*[]*string #
A list of regular expression patterns.
notes

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.

fieldMappingsoptionalIResolvable | IResolvable | CfnDataSource.DataSourceToIndexFieldMappingProperty[]field_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceToIndexFieldMappingProperty]]]fieldMappingsoptionalIResolvableFieldMappingsoptionalIResolvableFieldMappingsoptionalinterface{} #
A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields.
notes

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

inclusionPatternsoptionalstring[]inclusion_patternsoptionaltyping.List[str]inclusionPatternsoptionalList<String>InclusionPatternsoptionalstring[]InclusionPatternsoptional*[]*string #
A list of regular expression patterns to include certain documents in your SharePoint.
notes

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.

secretArnstringsecret_arnstrsecretArnStringSecretArnstringSecretArn*string required #
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 .

sharePointVersionstringshare_point_versionstrsharePointVersionStringSharePointVersionstringSharePointVersion*string required #
The version of Microsoft SharePoint that you use.
sslCertificateS3PathoptionalIResolvable | CfnDataSource.S3PathPropertyssl_certificate_s3_pathoptionaltyping.Union[IResolvable, S3PathProperty]sslCertificateS3PathoptionalIResolvableSslCertificateS3PathoptionalIResolvableSslCertificateS3Pathoptionalinterface{} #
Information required to find a specific file in an Amazon S3 bucket.
urlsstring[]urlstyping.List[str]urlsList<String>Urlsstring[]Urls*[]*string required #
The Microsoft SharePoint site URLs for the documents you want to index.
useChangeLogoptionalboolean | IResolvableuse_change_logoptionaltyping.Union[bool, IResolvable]useChangeLogoptionalBooleanUseChangeLogoptionalboolUseChangeLogoptionalinterface{} #
`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.

vpcConfigurationoptionalIResolvable | CfnDataSource.DataSourceVpcConfigurationPropertyvpc_configurationoptionaltyping.Union[IResolvable, DataSourceVpcConfigurationProperty]vpcConfigurationoptionalIResolvableVpcConfigurationoptionalIResolvableVpcConfigurationoptionalinterface{} #
Provides information for connecting to an Amazon VPC.