kendra/aws.sdk.kotlin.services.kendra.model/FsxConfiguration

FsxConfiguration

Provides the configuration information to connect to Amazon FSx as your data source.

Amazon Kendra now supports an upgraded Amazon FSx Windows connector.

You must now use the TemplateConfiguration object instead of the FsxConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

Types

Builder

class Builder

Companion

object Companion

Properties

exclusionPatterns

val exclusionPatterns: List<String>?

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

fieldMappings

val fieldMappings: List<DataSourceToIndexFieldMapping>?

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

fileSystemId

val fileSystemId: String

The identifier of the Amazon FSx file system.

fileSystemType

val fileSystemType: FsxFileSystemType

The Amazon FSx file system type. Windows is currently the only supported type.

inclusionPatterns

val inclusionPatterns: List<String>?

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

secretArn

val secretArn: String?

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:

vpcConfiguration

val vpcConfiguration: DataSourceVpcConfiguration?

Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.

Functions

copy

inline fun copy(block: FsxConfiguration.Builder.() -> Unit = {}): FsxConfiguration

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String