FsxConfiguration
Provides the configuration information to connect to Amazon FSx as your data source.
Note
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.
Contents
- FileSystemId
-
The identifier of the Amazon FSx file system.
You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.
Type: String
Length Constraints: Minimum length of 11. Maximum length of 21.
Pattern:
^(fs-[0-9a-f]{8,})$Required: Yes
- FileSystemType
-
The Amazon FSx file system type. Windows is currently the only supported type.
Type: String
Valid Values:
WINDOWSRequired: Yes
- VpcConfiguration
-
Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
Type: DataSourceVpcConfiguration object
Required: Yes
- ExclusionPatterns
-
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.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- FieldMappings
-
A list of
DataSourceToIndexFieldMappingobjects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndexAPI 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.Type: Array of DataSourceToIndexFieldMapping objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
- InclusionPatterns
-
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.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- SecretArn
-
The Amazon Resource Name (ARN) of an AWS 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:
-
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.
-
password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1284.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
