Class CfnDataSourcePropsMixin.SharePointConfigurationProperty

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

Inheritance

object

CfnDataSourcePropsMixin.SharePointConfigurationProperty

Implements

CfnDataSourcePropsMixin.ISharePointConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDataSourcePropsMixin.SharePointConfigurationProperty : CfnDataSourcePropsMixin.ISharePointConfigurationProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.SharePointConfigurationProperty Implements CfnDataSourcePropsMixin.ISharePointConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html

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.Mixins.Preview.AWS.Kendra.Mixins;

             var sharePointConfigurationProperty = new SharePointConfigurationProperty {
                 CrawlAttachments = false,
                 DisableLocalGroups = false,
                 DocumentTitleFieldName = "documentTitleFieldName",
                 ExclusionPatterns = new [] { "exclusionPatterns" },
                 FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } },
                 InclusionPatterns = new [] { "inclusionPatterns" },
                 SecretArn = "secretArn",
                 SharePointVersion = "sharePointVersion",
                 SslCertificateS3Path = new S3PathProperty {
                     Bucket = "bucket",
                     Key = "key"
                 },
                 Urls = new [] { "urls" },
                 UseChangeLog = false,
                 VpcConfiguration = new DataSourceVpcConfigurationProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Synopsis

Constructors

SharePointConfigurationProperty()

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

Properties

CrawlAttachments	`TRUE` to index document attachments.
DisableLocalGroups	`TRUE` to disable local groups information.
DocumentTitleFieldName	The Microsoft SharePoint attribute field that contains the title of the document.
ExclusionPatterns	A list of regular expression patterns.
FieldMappings	A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields.
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	`TRUE` to use the SharePoint change log to determine which documents require updating in the index.
VpcConfiguration	Provides information for connecting to an Amazon VPC.

Constructors

SharePointConfigurationProperty()

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

public SharePointConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html

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.Mixins.Preview.AWS.Kendra.Mixins;

             var sharePointConfigurationProperty = new SharePointConfigurationProperty {
                 CrawlAttachments = false,
                 DisableLocalGroups = false,
                 DocumentTitleFieldName = "documentTitleFieldName",
                 ExclusionPatterns = new [] { "exclusionPatterns" },
                 FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } },
                 InclusionPatterns = new [] { "inclusionPatterns" },
                 SecretArn = "secretArn",
                 SharePointVersion = "sharePointVersion",
                 SslCertificateS3Path = new S3PathProperty {
                     Bucket = "bucket",
                     Key = "key"
                 },
                 Urls = new [] { "urls" },
                 UseChangeLog = false,
                 VpcConfiguration = new DataSourceVpcConfigurationProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Properties

CrawlAttachments

TRUE to index document attachments.

public object? CrawlAttachments { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-crawlattachments

Type union: either bool or IResolvable

DisableLocalGroups

TRUE to disable local groups information.

public object? DisableLocalGroups { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-disablelocalgroups

Type union: either bool or IResolvable

DocumentTitleFieldName

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

public string? DocumentTitleFieldName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-documenttitlefieldname

ExclusionPatterns

A list of regular expression patterns.

public string[]? ExclusionPatterns { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-exclusionpatterns

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

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-fieldmappings

Type union: either IResolvable or (either IResolvable or CfnDataSourcePropsMixin.IDataSourceToIndexFieldMappingProperty)[]

InclusionPatterns

A list of regular expression patterns to include certain documents in your SharePoint.

public string[]? InclusionPatterns { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-inclusionpatterns

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

string

Remarks

For more information, see Microsoft SharePoint .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-secretarn

SharePointVersion

The version of Microsoft SharePoint that you use.

public string? SharePointVersion { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-sharepointversion

SslCertificateS3Path

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

public object? SslCertificateS3Path { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-sslcertificates3path

Type union: either IResolvable or CfnDataSourcePropsMixin.IS3PathProperty

Urls

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

public string[]? Urls { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-urls

UseChangeLog

TRUE to use the SharePoint change log to determine which documents require updating in the index.

public object? UseChangeLog { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-usechangelog

Type union: either bool or IResolvable

VpcConfiguration

Provides information for connecting to an Amazon VPC.

public object? VpcConfiguration { get; set; }