Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Class CfnDataSourcePropsMixin.SharePointConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.kendra.CfnDataSourcePropsMixin.SharePointConfigurationProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnDataSourcePropsMixin.SharePointConfigurationProperty

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

A builder for CfnDataSourcePropsMixin.SharePointConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

crawlAttachments

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getCrawlAttachments()

Parameters:

crawlAttachments - TRUE to index document attachments.

Returns:

this

crawlAttachments

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getCrawlAttachments()

Parameters:

crawlAttachments - TRUE to index document attachments.

Returns:

this

disableLocalGroups

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getDisableLocalGroups()

Parameters:

disableLocalGroups - TRUE to disable local groups information.

Returns:

this

disableLocalGroups

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getDisableLocalGroups()

Parameters:

disableLocalGroups - TRUE to disable local groups information.

Returns:

this

documentTitleFieldName

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getDocumentTitleFieldName()

Parameters:

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

Returns:

this

exclusionPatterns

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

Sets the value of CfnDataSourcePropsMixin.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 CfnDataSourcePropsMixin.SharePointConfigurationProperty.Builder fieldMappings(IResolvable fieldMappings)

Sets the value of CfnDataSourcePropsMixin.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 CfnDataSourcePropsMixin.SharePointConfigurationProperty.Builder fieldMappings(List<? extends Object> fieldMappings)

Sets the value of CfnDataSourcePropsMixin.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 CfnDataSourcePropsMixin.SharePointConfigurationProperty.Builder inclusionPatterns(List<String> inclusionPatterns)

Sets the value of CfnDataSourcePropsMixin.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

secretArn

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

Sets the value of CfnDataSourcePropsMixin.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. For more information, see Microsoft SharePoint .

Returns:

this

sharePointVersion

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getSharePointVersion()

Parameters:

sharePointVersion - The version of Microsoft SharePoint that you use.

Returns:

this

sslCertificateS3Path

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getSslCertificateS3Path()

Parameters:

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

Returns:

this

sslCertificateS3Path

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getSslCertificateS3Path()

Parameters:

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

Returns:

this

urls

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getUrls()

Parameters:

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

Returns:

this

useChangeLog

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

Sets the value of CfnDataSourcePropsMixin.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 CfnDataSourcePropsMixin.SharePointConfigurationProperty.Builder useChangeLog(IResolvable useChangeLog)

Sets the value of CfnDataSourcePropsMixin.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 CfnDataSourcePropsMixin.SharePointConfigurationProperty.Builder vpcConfiguration(IResolvable vpcConfiguration)

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - Provides information for connecting to an Amazon VPC.

Returns:

this

vpcConfiguration

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

Sets the value of CfnDataSourcePropsMixin.SharePointConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - Provides information for connecting to an Amazon VPC.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDataSourcePropsMixin.SharePointConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided