Package software.amazon.awscdk.services.kendra

Class CfnDataSource.WorkDocsConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnDataSource.WorkDocsConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDataSource.WorkDocsConfigurationProperty

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

An implementation for CfnDataSource.WorkDocsConfigurationProperty

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

CfnDataSource.WorkDocsConfigurationProperty.Builder, CfnDataSource.WorkDocsConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDataSource.WorkDocsConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDataSource.WorkDocsConfigurationProperty.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	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getCrawlComments()	TRUE to include comments on documents in your index.
final List<String>	getExclusionPatterns()	A list of regular expression patterns to exclude certain files in your WorkDocs site repository.
final Object	getFieldMappings()	A list of DataSourceToIndexFieldMapping objects that map WorkDocs data source attributes or field names to Amazon Kendra index field names.
final List<String>	getInclusionPatterns()	A list of regular expression patterns to include certain files in your WorkDocs site repository.
final String	getOrganizationId()	The identifier of the directory corresponding to your WorkDocs site repository.
final Object	getUseChangeLog()	TRUE to use the WorkDocs change log to determine which documents require updating in the index.
final 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

Constructor Details

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.WorkDocsConfigurationProperty.Builder builder)

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

Method Details

getOrganizationId

public final String getOrganizationId()

Description copied from interface: CfnDataSource.WorkDocsConfigurationProperty

The identifier of the directory corresponding to your WorkDocs site repository.

You can find the organization ID in the AWS Directory Service by going to Active Directory , then Directories . Your WorkDocs site directory has an ID, which is the organization ID. You can also set up a new WorkDocs directory in the AWS Directory Service console and enable a WorkDocs site for the directory in the WorkDocs console.

Specified by:

getOrganizationId in interface CfnDataSource.WorkDocsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-organizationid

getCrawlComments

public final Object getCrawlComments()

Description copied from interface: CfnDataSource.WorkDocsConfigurationProperty

TRUE to include comments on documents in your index.

Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE .

Returns union: either Boolean or IResolvable

Specified by:

getCrawlComments in interface CfnDataSource.WorkDocsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-crawlcomments

getExclusionPatterns

public final List<String> getExclusionPatterns()

Description copied from interface: CfnDataSource.WorkDocsConfigurationProperty

A list of regular expression patterns to exclude certain files in your WorkDocs site repository.

Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

Specified by:

getExclusionPatterns in interface CfnDataSource.WorkDocsConfigurationProperty

See Also:

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

getFieldMappings

public final Object getFieldMappings()

Description copied from interface: CfnDataSource.WorkDocsConfigurationProperty

A list of DataSourceToIndexFieldMapping objects that map WorkDocs data source attributes or field names to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to WorkDocs fields. For more information, see Mapping data source fields . The WorkDocs data source field names must exist in your WorkDocs custom metadata.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSource.DataSourceToIndexFieldMappingProperty>

Specified by:

getFieldMappings in interface CfnDataSource.WorkDocsConfigurationProperty

See Also:

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

getInclusionPatterns

public final List<String> getInclusionPatterns()

Description copied from interface: CfnDataSource.WorkDocsConfigurationProperty

A list of regular expression patterns to include certain files in your WorkDocs site repository.

Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

Specified by:

getInclusionPatterns in interface CfnDataSource.WorkDocsConfigurationProperty

See Also:

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

getUseChangeLog

public final Object getUseChangeLog()

Description copied from interface: CfnDataSource.WorkDocsConfigurationProperty

TRUE to use the WorkDocs 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 WorkDocs.

Returns union: either Boolean or IResolvable

Specified by:

getUseChangeLog in interface CfnDataSource.WorkDocsConfigurationProperty

See Also:

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

$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