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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_list_configurationTypes::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.



7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7347

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_nameString

The name of the bucket that contains the documents.

Returns:

  • (String)


7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7347

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_configurationTypes::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.



7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7347

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_patternsArray<String>

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples are:

  • .png , .jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

  • internal will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

  • /internal will exclude all internal-related files in a directory and its subdirectories.

Returns:

  • (Array<String>)


7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7347

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_patternsArray<String>

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples are:

  • *.txt will include all text files in a directory (files with the extension .txt).

  • */.txt will include all text files in a directory and its subdirectories.

  • tax will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

Returns:

  • (Array<String>)


7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7347

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_prefixesArray<String>

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

Returns:

  • (Array<String>)


7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7347

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