Class: Aws::Kendra::Types::S3DataSourceConfiguration

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

Overview

Provides the configuration information to connect to an Amazon S3 bucket.

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

You must now use the [TemplateConfiguration][1] object instead of the

‘S3DataSourceConfiguration` 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

#access_control_list_configuration ⇒ Types::AccessControlListConfiguration

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see [Access control for S3 data sources].

[1]: docs.aws.amazon.com/kendra/latest/dg/s3-acl.html

Returns:



8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
 
# File 'lib/aws-sdk-kendra/types.rb', line 8753

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_name ⇒ String

The name of the bucket that contains the documents.

Returns:

  • (String) 


8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
 
# File 'lib/aws-sdk-kendra/types.rb', line 8753

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#documents_metadata_configuration ⇒ Types::DocumentsMetadataConfiguration

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

Returns:



8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
 
# File 'lib/aws-sdk-kendra/types.rb', line 8753

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ Array<String>

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

  • /myapp/config/*—All files inside config directory.

  • **/.png*—All .png files in all directories.

  • **/.{png, ico, md\}*—All .png, .ico or .md files in all directories.

  • /myapp/src/*/.ts—All .ts files inside src directory (and all its subdirectories).

  • ***/!(*.module).ts*—All .ts files but not .module.ts

  • **.png , .jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

  • internal—All files in a directory that contain ‘internal’ in the file name, such as ‘internal’, ‘internal_only’, ‘company_internal’.

  • ***/internal*—All internal-related files in a directory and its subdirectories.

For more examples, see [Use of Exclude and Include Filters] in the Amazon Web Services CLI Command Reference.

[1]: docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters

Returns:

  • (Array<String>) 


8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
 
# File 'lib/aws-sdk-kendra/types.rb', line 8753

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<String>

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

  • /myapp/config/*—All files inside config directory.

  • **/.png*—All .png files in all directories.

  • **/.{png, ico, md\}*—All .png, .ico or .md files in all directories.

  • /myapp/src/*/.ts—All .ts files inside src directory (and all its subdirectories).

  • ***/!(*.module).ts*—All .ts files but not .module.ts

  • **.png , .jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

  • internal—All files in a directory that contain ‘internal’ in the file name, such as ‘internal’, ‘internal_only’, ‘company_internal’.

  • ***/internal*—All internal-related files in a directory and its subdirectories.

For more examples, see [Use of Exclude and Include Filters] in the Amazon Web Services CLI Command Reference.

[1]: docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters

Returns:

  • (Array<String>) 


8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
 
# File 'lib/aws-sdk-kendra/types.rb', line 8753

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_prefixes ⇒ Array<String>

A list of S3 prefixes for the documents that should be included in the index.

Returns:

  • (Array<String>) 


8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
 
# File 'lib/aws-sdk-kendra/types.rb', line 8753

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end