kendra/aws.sdk.kotlin.services.kendra.model/QuipConfiguration/Builder

Builder

Properties

var attachmentFieldMappings: List<DataSourceToIndexFieldMapping>?

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

crawlAttachments

var crawlAttachments: Boolean

TRUE to index attachments.

crawlChatRooms

var crawlChatRooms: Boolean

TRUE to index the contents of chat rooms.

crawlFileComments

var crawlFileComments: Boolean

TRUE to index file comments.

domain

var domain: String?

The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".

exclusionPatterns

var exclusionPatterns: List<String>?

A list of regular expression patterns to exclude certain files in your Quip file system. 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 pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

folderIds

var folderIds: List<String>?

The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".

inclusionPatterns

var inclusionPatterns: List<String>?

A list of regular expression patterns to include certain files in your Quip file system. 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 pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

messageFieldMappings

var messageFieldMappings: List<DataSourceToIndexFieldMapping>?

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

secretArn

var secretArn: String?

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:

threadFieldMappings

var threadFieldMappings: List<DataSourceToIndexFieldMapping>?

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

vpcConfiguration

var vpcConfiguration: DataSourceVpcConfiguration?

Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.

Functions

vpcConfiguration

fun vpcConfiguration(block: DataSourceVpcConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kendra.model.DataSourceVpcConfiguration inside the given block