software.amazon.awscdk.services.kendra

Class CfnDataSource.SharePointConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.kendra.CfnDataSource.SharePointConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDataSource.SharePointConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDataSource.SharePointConfigurationProperty

@Stability(value=Stable)
 @Internal
public static final class CfnDataSource.SharePointConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDataSource.SharePointConfigurationProperty

An implementation for CfnDataSource.SharePointConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kendra.CfnDataSource.SharePointConfigurationProperty

CfnDataSource.SharePointConfigurationProperty.Builder, CfnDataSource.SharePointConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(CfnDataSource.SharePointConfigurationProperty.Builder builder) Constructor that initializes the object based on literal property values passed by the CfnDataSource.AccessControlListConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Object	getCrawlAttachments() `TRUE` to index document attachments.
Object	getDisableLocalGroups() `TRUE` to disable local groups information.
String	getDocumentTitleFieldName() The Microsoft SharePoint attribute field that contains the title of the document.
List<String>	getExclusionPatterns() A list of regular expression patterns.
Object	getFieldMappings() A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields.
List<String>	getInclusionPatterns() A list of regular expression patterns to include certain documents in your SharePoint.
String	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.
String	getSharePointVersion() The version of Microsoft SharePoint that you use.
Object	getSslCertificateS3Path() Information required to find a specific file in an Amazon S3 bucket.
List<String>	getUrls() The Microsoft SharePoint site URLs for the documents you want to index.
Object	getUseChangeLog() `TRUE` to use the SharePoint change log to determine which documents require updating in the index.
Object	getVpcConfiguration() Provides information for connecting to an Amazon VPC.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.kendra.CfnDataSource.SharePointConfigurationProperty

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDataSource.SharePointConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDataSource.AccessControlListConfigurationProperty.Builder.

Method Detail

getSecretArn

public final String getSecretArn()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

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.

If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source .

You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a SharePoint data source .

Specified by:

getSecretArn in interface CfnDataSource.SharePointConfigurationProperty

getSharePointVersion

public final String getSharePointVersion()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

The version of Microsoft SharePoint that you use.

Specified by:

getSharePointVersion in interface CfnDataSource.SharePointConfigurationProperty

getUrls

public final List<String> getUrls()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

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

Specified by:

getUrls in interface CfnDataSource.SharePointConfigurationProperty

getCrawlAttachments

public final Object getCrawlAttachments()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

`TRUE` to index document attachments.

Specified by:

getCrawlAttachments in interface CfnDataSource.SharePointConfigurationProperty

getDisableLocalGroups

public final Object getDisableLocalGroups()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

`TRUE` to disable local groups information.

Specified by:

getDisableLocalGroups in interface CfnDataSource.SharePointConfigurationProperty

getDocumentTitleFieldName

public final String getDocumentTitleFieldName()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

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

Specified by:

getDocumentTitleFieldName in interface CfnDataSource.SharePointConfigurationProperty

getExclusionPatterns

public final List<String> getExclusionPatterns()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

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.

Specified by:

getExclusionPatterns in interface CfnDataSource.SharePointConfigurationProperty

getFieldMappings

public final Object getFieldMappings()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

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 .

Specified by:

getFieldMappings in interface CfnDataSource.SharePointConfigurationProperty

getInclusionPatterns

public final List<String> getInclusionPatterns()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

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.

Specified by:

getInclusionPatterns in interface CfnDataSource.SharePointConfigurationProperty

getSslCertificateS3Path

public final Object getSslCertificateS3Path()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

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

Specified by:

getSslCertificateS3Path in interface CfnDataSource.SharePointConfigurationProperty

getUseChangeLog

public final Object getUseChangeLog()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

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

Specified by:

getUseChangeLog in interface CfnDataSource.SharePointConfigurationProperty

getVpcConfiguration

public final Object getVpcConfiguration()

Description copied from interface: CfnDataSource.SharePointConfigurationProperty

Provides information for connecting to an Amazon VPC.

Specified by:

getVpcConfiguration in interface CfnDataSource.SharePointConfigurationProperty

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object