Interface CfnDataSource.SharePointConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSource.SharePointConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDataSource
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataSource.SharePointConfigurationProperty
static final class
An implementation forCfnDataSource.SharePointConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
TRUE
to index document attachments.default Object
TRUE
to disable local groups information.default String
The Microsoft SharePoint attribute field that contains the title of the document.A list of regular expression patterns.default Object
A list ofDataSourceToIndexFieldMapping
objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields.A list of regular expression patterns to include certain documents in your SharePoint.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.The version of Microsoft SharePoint that you use.default Object
Information required to find a specific file in an Amazon S3 bucket.getUrls()
The Microsoft SharePoint site URLs for the documents you want to index.default Object
TRUE
to use the SharePoint change log to determine which documents require updating in the index.default Object
Provides information for connecting to an Amazon VPC.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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 .
- See Also:
-
getUrls
The Microsoft SharePoint site URLs for the documents you want to index.- See Also:
-
getCrawlAttachments
TRUE
to index document attachments.- See Also:
-
getDisableLocalGroups
TRUE
to disable local groups information.- See Also:
-
getDocumentTitleFieldName
The Microsoft SharePoint attribute field that contains the title of the document.- See Also:
-
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.
- See Also:
-
getFieldMappings
A list ofDataSourceToIndexFieldMapping
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 .
- See Also:
-
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.
- See Also:
-
getSslCertificateS3Path
Information required to find a specific file in an Amazon S3 bucket.- See Also:
-
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.
- See Also:
-
getVpcConfiguration
Provides information for connecting to an Amazon VPC.- See Also:
-
builder
-