Class: Aws::Kendra::Types::FsxConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

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

<note markdown=“1”> Amazon Kendra now supports an upgraded Amazon FSx Windows connector.

You must now use the [TemplateConfiguration][1] 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.

</note>

[1]: docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exclusion_patterns ⇒ Array<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.

Returns:

  • (Array<String>) 


5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/aws-sdk-kendra/types.rb', line 5694

class FsxConfiguration < Struct.new(
  :file_system_id,
  :file_system_type,
  :vpc_configuration,
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::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.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:



5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/aws-sdk-kendra/types.rb', line 5694

class FsxConfiguration < Struct.new(
  :file_system_id,
  :file_system_type,
  :vpc_configuration,
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ String

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

[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html

Returns:

  • (String) 


5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/aws-sdk-kendra/types.rb', line 5694

class FsxConfiguration < Struct.new(
  :file_system_id,
  :file_system_type,
  :vpc_configuration,
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_type ⇒ String

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

Returns:

  • (String) 


5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/aws-sdk-kendra/types.rb', line 5694

class FsxConfiguration < Struct.new(
  :file_system_id,
  :file_system_type,
  :vpc_configuration,
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<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.

Returns:

  • (Array<String>) 


5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/aws-sdk-kendra/types.rb', line 5694

class FsxConfiguration < Struct.new(
  :file_system_id,
  :file_system_type,
  :vpc_configuration,
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ 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:

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

Returns:

  • (String) 


5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/aws-sdk-kendra/types.rb', line 5694

class FsxConfiguration < Struct.new(
  :file_system_id,
  :file_system_type,
  :vpc_configuration,
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

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

Returns:



5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/aws-sdk-kendra/types.rb', line 5694

class FsxConfiguration < Struct.new(
  :file_system_id,
  :file_system_type,
  :vpc_configuration,
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end