class Aws::Kendra::Types::S3DataSourceConfiguration

Provides configuration information for a data source to index documents in an Amazon S3 bucket.

@note When making an API call, you may pass S3DataSourceConfiguration

data as a hash:

    {
      bucket_name: "S3BucketName", # required
      inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
      inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
      exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
      documents_metadata_configuration: {
        s3_prefix: "S3ObjectKey",
      },
      access_control_list_configuration: {
        key_path: "S3ObjectKey",
      },
    }

@!attribute [rw] bucket_name

The name of the bucket that contains the documents.
@return [String]

@!attribute [rw] inclusion_prefixes

A list of S3 prefixes for the documents that should be included in
the index.
@return [Array<String>]

@!attribute [rw] inclusion_patterns

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][1] 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'.

[1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
@return [Array<String>]

@!attribute [rw] exclusion_patterns

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

[1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
@return [Array<String>]

@!attribute [rw] documents_metadata_configuration

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.
@return [Types::DocumentsMetadataConfiguration]

@!attribute [rw] access_control_list_configuration

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

[1]: https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html
@return [Types::AccessControlListConfiguration]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/S3DataSourceConfiguration AWS API Documentation

Constants

SENSITIVE