Package software.amazon.awscdk.services.kendra

Class CfnDataSource.SharePointConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnDataSource.SharePointConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSource.SharePointConfigurationProperty>

Enclosing interface:

CfnDataSource.SharePointConfigurationProperty

@Stability(Stable)
public static final class CfnDataSource.SharePointConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSource.SharePointConfigurationProperty>

A builder for CfnDataSource.SharePointConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSource.SharePointConfigurationProperty	build()	Builds the configured instance.
CfnDataSource.SharePointConfigurationProperty.Builder	crawlAttachments(Boolean crawlAttachments)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getCrawlAttachments()
CfnDataSource.SharePointConfigurationProperty.Builder	crawlAttachments(IResolvable crawlAttachments)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getCrawlAttachments()
CfnDataSource.SharePointConfigurationProperty.Builder	disableLocalGroups(Boolean disableLocalGroups)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getDisableLocalGroups()
CfnDataSource.SharePointConfigurationProperty.Builder	disableLocalGroups(IResolvable disableLocalGroups)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getDisableLocalGroups()
CfnDataSource.SharePointConfigurationProperty.Builder	documentTitleFieldName(String documentTitleFieldName)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getDocumentTitleFieldName()
CfnDataSource.SharePointConfigurationProperty.Builder	exclusionPatterns(List<String> exclusionPatterns)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getExclusionPatterns()
CfnDataSource.SharePointConfigurationProperty.Builder	fieldMappings(List<? extends Object> fieldMappings)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getFieldMappings()
CfnDataSource.SharePointConfigurationProperty.Builder	fieldMappings(IResolvable fieldMappings)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getFieldMappings()
CfnDataSource.SharePointConfigurationProperty.Builder	inclusionPatterns(List<String> inclusionPatterns)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getInclusionPatterns()
CfnDataSource.SharePointConfigurationProperty.Builder	secretArn(String secretArn)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getSecretArn()
CfnDataSource.SharePointConfigurationProperty.Builder	sharePointVersion(String sharePointVersion)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getSharePointVersion()
CfnDataSource.SharePointConfigurationProperty.Builder	sslCertificateS3Path(IResolvable sslCertificateS3Path)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getSslCertificateS3Path()
CfnDataSource.SharePointConfigurationProperty.Builder	sslCertificateS3Path(CfnDataSource.S3PathProperty sslCertificateS3Path)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getSslCertificateS3Path()
CfnDataSource.SharePointConfigurationProperty.Builder	urls(List<String> urls)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getUrls()
CfnDataSource.SharePointConfigurationProperty.Builder	useChangeLog(Boolean useChangeLog)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getUseChangeLog()
CfnDataSource.SharePointConfigurationProperty.Builder	useChangeLog(IResolvable useChangeLog)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getUseChangeLog()
CfnDataSource.SharePointConfigurationProperty.Builder	vpcConfiguration(IResolvable vpcConfiguration)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getVpcConfiguration()
CfnDataSource.SharePointConfigurationProperty.Builder	vpcConfiguration(CfnDataSource.DataSourceVpcConfigurationProperty vpcConfiguration)	Sets the value of CfnDataSource.SharePointConfigurationProperty.getVpcConfiguration()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

secretArn

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder secretArn(String secretArn)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getSecretArn()

Parameters:

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. This parameter is required. For more information, see Microsoft SharePoint .

Returns:

this

sharePointVersion

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder sharePointVersion(String sharePointVersion)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getSharePointVersion()

Parameters:

sharePointVersion - The version of Microsoft SharePoint that you use. This parameter is required.

Returns:

this

urls

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder urls(List<String> urls)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getUrls()

Parameters:

urls - The Microsoft SharePoint site URLs for the documents you want to index. This parameter is required.

Returns:

this

crawlAttachments

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder crawlAttachments(Boolean crawlAttachments)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getCrawlAttachments()

Parameters:

crawlAttachments - TRUE to index document attachments.

Returns:

this

crawlAttachments

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder crawlAttachments(IResolvable crawlAttachments)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getCrawlAttachments()

Parameters:

crawlAttachments - TRUE to index document attachments.

Returns:

this

disableLocalGroups

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder disableLocalGroups(Boolean disableLocalGroups)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getDisableLocalGroups()

Parameters:

disableLocalGroups - TRUE to disable local groups information.

Returns:

this

disableLocalGroups

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder disableLocalGroups(IResolvable disableLocalGroups)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getDisableLocalGroups()

Parameters:

disableLocalGroups - TRUE to disable local groups information.

Returns:

this

documentTitleFieldName

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder documentTitleFieldName(String documentTitleFieldName)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getDocumentTitleFieldName()

Parameters:

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

Returns:

this

exclusionPatterns

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder exclusionPatterns(List<String> exclusionPatterns)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getExclusionPatterns()

Parameters:

exclusionPatterns - 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.

Returns:

this

fieldMappings

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder fieldMappings(IResolvable fieldMappings)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getFieldMappings()

Parameters:

fieldMappings - 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 .

Returns:

this

fieldMappings

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder fieldMappings(List<? extends Object> fieldMappings)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getFieldMappings()

Parameters:

fieldMappings - 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 .

Returns:

this

inclusionPatterns

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder inclusionPatterns(List<String> inclusionPatterns)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getInclusionPatterns()

Parameters:

inclusionPatterns - 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.

Returns:

this

sslCertificateS3Path

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder sslCertificateS3Path(IResolvable sslCertificateS3Path)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getSslCertificateS3Path()

Parameters:

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

Returns:

this

sslCertificateS3Path

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder sslCertificateS3Path(CfnDataSource.S3PathProperty sslCertificateS3Path)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getSslCertificateS3Path()

Parameters:

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

Returns:

this

useChangeLog

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder useChangeLog(Boolean useChangeLog)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getUseChangeLog()

Parameters:

useChangeLog - 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.

Returns:

this

useChangeLog

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder useChangeLog(IResolvable useChangeLog)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getUseChangeLog()

Parameters:

useChangeLog - 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.

Returns:

this

vpcConfiguration

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder vpcConfiguration(IResolvable vpcConfiguration)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - Provides information for connecting to an Amazon VPC.

Returns:

this

vpcConfiguration

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty.Builder vpcConfiguration(CfnDataSource.DataSourceVpcConfigurationProperty vpcConfiguration)

Sets the value of CfnDataSource.SharePointConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - Provides information for connecting to an Amazon VPC.

Returns:

this

build

@Stability(Stable)
public CfnDataSource.SharePointConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSource.SharePointConfigurationProperty>

Returns:

a new instance of CfnDataSource.SharePointConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided