Class CfnDataSource.SharePointConfigurationProperty
Provides the configuration information to connect to Microsoft SharePoint as your data source.
Inheritance
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SharePointConfigurationProperty : Object, CfnDataSource.ISharePointConfigurationProperty
Syntax (vb)
Public Class SharePointConfigurationProperty
Inherits Object
Implements CfnDataSource.ISharePointConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// 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" }
}
};
Synopsis
Constructors
SharePointConfigurationProperty() |
Properties
CrawlAttachments |
|
DisableLocalGroups |
|
DocumentTitleFieldName | The Microsoft SharePoint attribute field that contains the title of the document. |
ExclusionPatterns | A list of regular expression patterns. |
FieldMappings | A list of |
InclusionPatterns | A list of regular expression patterns to include certain documents in your SharePoint. |
SecretArn | 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. |
SharePointVersion | The version of Microsoft SharePoint that you use. |
SslCertificateS3Path | Information required to find a specific file in an Amazon S3 bucket. |
Urls | The Microsoft SharePoint site URLs for the documents you want to index. |
UseChangeLog |
|
VpcConfiguration | Provides information for connecting to an Amazon VPC. |
Constructors
SharePointConfigurationProperty()
public SharePointConfigurationProperty()
Properties
CrawlAttachments
TRUE
to index document attachments.
public object CrawlAttachments { get; set; }
Property Value
System.Object
Remarks
DisableLocalGroups
TRUE
to disable local groups information.
public object DisableLocalGroups { get; set; }
Property Value
System.Object
Remarks
DocumentTitleFieldName
The Microsoft SharePoint attribute field that contains the title of the document.
public string DocumentTitleFieldName { get; set; }
Property Value
System.String
Remarks
ExclusionPatterns
A list of regular expression patterns.
public string[] ExclusionPatterns { get; set; }
Property Value
System.String[]
Remarks
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
A list of DataSourceToIndexFieldMapping
objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields.
public object FieldMappings { get; set; }
Property Value
System.Object
Remarks
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
A list of regular expression patterns to include certain documents in your SharePoint.
public string[] InclusionPatterns { get; set; }
Property Value
System.String[]
Remarks
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.
SecretArn
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.
public string SecretArn { get; set; }
Property Value
System.String
Remarks
SharePointVersion
The version of Microsoft SharePoint that you use.
public string SharePointVersion { get; set; }
Property Value
System.String
Remarks
SslCertificateS3Path
Information required to find a specific file in an Amazon S3 bucket.
public object SslCertificateS3Path { get; set; }
Property Value
System.Object
Remarks
Urls
The Microsoft SharePoint site URLs for the documents you want to index.
public string[] Urls { get; set; }
Property Value
System.String[]
Remarks
UseChangeLog
TRUE
to use the SharePoint change log to determine which documents require updating in the index.
public object UseChangeLog { get; set; }
Property Value
System.Object
Remarks
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
Provides information for connecting to an Amazon VPC.
public object VpcConfiguration { get; set; }
Property Value
System.Object